Documentation / joplin-plugin-api / SettingItem
Interface: SettingItem
Properties
advanced?
optionaladvanced:boolean
An advanced setting will be moved under the "Advanced" button in the config screen.
Defined in
appTypes?
optionalappTypes:AppType[]
Reserved property. Not used at the moment.
Defined in
description?
optionaldescription:string
Defined in
isEnum?
optionalisEnum:boolean
To create a setting with multiple options, set this property to true. That setting will render as a dropdown list in the configuration screen.
Defined in
label
label:
string
Defined in
maximum?
optionalmaximum:number
Defined in
minimum?
optionalminimum:number
Set the min, max and step values if you want to restrict an int setting to a particular range.
Defined in
options?
optionaloptions:Record<any,any>
This property is required when isEnum is true. In which case, it should contain a map of value => label.
Defined in
public
public:
boolean
A public setting will appear in the Configuration screen and will be modifiable by the user. A private setting however will not appear there, and can only be changed programmatically. You may use this to store some values that you do not want to directly expose.
Defined in
section?
optionalsection:string
You would usually set this to a section you would have created specifically for the plugin.
Defined in
secure?
optionalsecure:boolean
Set this to true to store secure data, such as passwords. Any such setting will be stored in the system keychain if one is available.
Defined in
step?
optionalstep:number
Defined in
storage?
optionalstorage:SettingStorage
Either store the setting in the database or in settings.json. Defaults to database.
Defined in
subType?
optionalsubType:SettingItemSubType
Currently only used to display a file or directory selector. Always set type to SettingItemType.String when using this property.
Defined in
type
type:
SettingItemType
Defined in
value
value:
any