Type Alias SettingBase

SettingBase: StateBase & {
    description?: LocalizeKey;
    isHidden?: 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.

  • label: LocalizeKey

    LocalizeKey that displays in the settings dialog as the setting name