Skip to main content

Module: ui/settings

Functions

addSettingsItem

addSettingsItem(messageOptions): Promise<void>

Parameters

NameType
messageOptionsMessageDataType<"settingsItemAdd">

Returns

Promise<void>

Defined in

src/channel.ts:462

Type Aliases

settingsItemAdd

Ƭ settingsItemAdd: Object

Type declaration

NameTypeDescription
responseTypevoid-
labelstringLabel of the settings item.
locationIdstringThe locationId you want to display.
iconiconsThe icon to display in your settings item.
tab?"shop" | "system" | "plugins"Determines in which tab your settings item will be displayed. Defaults to plugins.
displaySearchBar?booleanToggles the sw-page search bar on/off. Defaults to true.

Defined in

src/ui/settings/index.ts:6