platform-bible-utils
    Preparing search index...

    Type Alias SettingBase

    SettingBase: StateBase & {
        description?: LocalizeKey;
        isHidden?: boolean;
        isReadOnly?: boolean;
        label: LocalizeKey;
        [k: string]: unknown;
    }

    Base information needed to describe a setting entry

    Type declaration

    • [k: string]: unknown
    • Optionaldescription?: LocalizeKey

      LocalizeKey that displays in the settings dialog to describe the setting

    • OptionalisHidden?: boolean

      Boolean that controls whether a setting should be hidden or not. If hidden, the setting will not show up in the settings dialog in paranext-core, and thus will not be configurable by the user unless an extension provides a way to interact with the setting. If every setting in a group is hidden, the group does not show up either.

    • OptionalisReadOnly?: boolean

      Boolean that controls whether a setting is read-only in the settings dialog. If read-only, the setting still shows up in the settings dialog in paranext-core, but the user cannot change it there. A read-only text field can still be selected and copied; controls with no read-only state, such as switches, are disabled. Extensions can still change the setting's value.

    • label: LocalizeKey

      LocalizeKey that displays in the settings dialog as the setting name