PopClip JavaScript API Reference
    Preparing search index...

    Interface StringOption

    A string-valued option.

    interface StringOption {
        defaultValue?: string;
        description?: LocalizableString;
        hidden?: boolean;
        identifier: string;
        inset?: boolean;
        label?: LocalizableString;
        multiline?: boolean;
        type: "string";
    }

    Hierarchy (View Summary)

    Index
    defaultValue? description? hidden? identifier inset? label? multiline? type
    defaultValue?: string

    The default value of the option. If omitted, string options default to the empty string.

    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.

    label?: LocalizableString

    A short label for this option.

    multiline?: boolean

    If true, show a multi-line text field instead of a single-line one. Useful for longer inputs such as prompts. Default is false.

    type: "string"

    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