ComPDFKit Web SDK
    Preparing search index...

    Interface CustomSettingItem

    One item of UI.setCustomSettings: one switch row in the settings dialog (UI.CustomSettingItem).

    interface CustomSettingItem {
        description: string;
        isChecked: boolean | (() => boolean);
        label: string;
        onToggled(checked: boolean): void;
    }
    Index
    • Called immediately when the switch is toggled.

      Parameters

      • checked: boolean

        The new state of the switch.

      Returns void

    description: string

    Description shown under the label.

    isChecked: boolean | (() => boolean)

    State of the switch, or a function returning it (called again after each toggle).

    label: string

    Label of the row.