PopClip JavaScript API Reference
    Preparing search index...

    Interface SecretOption

    A concealed string option, persisted in the user's keychain.

    interface SecretOption {
        description?: LocalizableString;
        hidden?: boolean;
        identifier: string;
        inset?: boolean;
        keychain?: "sync" | "local";
        label?: LocalizableString;
        type: "secret";
    }

    Hierarchy (View Summary)

    Index
    description? hidden? identifier inset? keychain? label? type
    description?: LocalizableString

    An optional longer explanation of this option, to be shown in the UI.

    hidden?: boolean

    If true, this option will be hidden in the prefs window. Default is false.

    identifier: string

    An identifying string for this option.

    inset?: boolean

    If true, this option will be inset to the right of its label, instead of below it. Default is false.

    keychain?: "sync" | "local"

    Which keychain the secret goes in: sync (the default) — the synchronizable keychain, shared across the user's devices via iCloud Keychain — or local, kept only on the Mac where it was entered.

    label?: LocalizableString

    A short label for this option.

    type: "secret"

    The kind of option, one of:

    • string: a text box for free text entry,
    • boolean: a check box,
    • multiple: multiple-choice drop-down with predefined options,
    • secret: concealed text entry field (persisted in user's keychain),
    • password: concealed text entry field (not persisted, only passed to auth function),
    • heading: adds a heading in the user interface, but does not actually define an option

    Settings
    Member Visibility

    On This Page
    Properties