Documentation / joplin-plugin-api / SettingItem

Interface: SettingItem

Defined in: types.ts:408

Properties

advanced?

optional advanced: boolean

Defined in: types.ts:462

An advanced setting will be moved under the "Advanced" button in the config screen.

---

appTypes?

optional appTypes: AppType[]

Defined in: types.ts:450

Reserved property. Not used at the moment.

---

description?

optional description: string

Defined in: types.ts:419

---

isEnum?

optional isEnum: boolean

Defined in: types.ts:439

To create a setting with multiple options, set this property to true. That setting will render as a dropdown list in the configuration screen.

---

label

label: string

Defined in: types.ts:418

---

maximum?

optional maximum: number

Defined in: types.ts:469

---

minimum?

optional minimum: number

Defined in: types.ts:468

Set the min, max and step values if you want to restrict an int setting to a particular range.

---

options?

optional options: Record<any, any>

Defined in: types.ts:445

This property is required when isEnum is true. In which case, it should contain a map of value => label.

---

public

public: boolean

Defined in: types.ts:427

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.

---

section?

optional section: string

Defined in: types.ts:433

You would usually set this to a section you would have created specifically for the plugin.

---

secure?

optional secure: boolean

Defined in: types.ts:456

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.

---

step?

optional step: number

Defined in: types.ts:470

---

storage?

optional storage: SettingStorage

Defined in: types.ts:475

Either store the setting in the database or in settings.json. Defaults to database.

---

subType?

optional subType: SettingItemSubType

Defined in: types.ts:416

Currently only used to display a file or directory selector. Always set type to SettingItemType.String when using this property.

---

type

type: SettingItemType

Defined in: types.ts:410

---

value

value: any

Defined in: types.ts:409