Skip to content

modern-pdf-lib


modern-pdf-lib / AppearanceProviderFor

Type Alias: AppearanceProviderFor<T>

AppearanceProviderFor<T> = T extends "text" ? (options) => PdfStream : T extends "checkbox" ? (options) => PdfStream : T extends "radio" ? (options) => PdfStream : T extends "dropdown" ? (options) => PdfStream : T extends "listbox" ? (options) => PdfStream : T extends "button" ? (options) => PdfStream : T extends "signature" ? (options) => PdfStream : never

Defined in: src/form/fieldAppearance.ts:38

A typed function that generates an appearance stream for a specific field type. Use this as a callback type when providing custom appearance generators.

ts
const myTextProvider: AppearanceProviderFor<'text'> = (opts) => {
  // custom rendering logic
  return myStream;
};

Type Parameters

T

T extends FieldType

Released under the MIT License.