Interface IPluginFeature<T>

interface IPluginFeature {
    defaultSettings?: T;
    enabled: boolean;
    help?: string;
    helpUrl?: string;
    id?: string;
    settingName: string;
    title?: string;
    type: string;
}

Type Parameters

  • T

Hierarchy

Properties

defaultSettings? enabled help? helpUrl? id? settingName title? type

Properties

Optional defaultSettings

defaultSettings?: T

Default settings when nothing has been save yet

enabled

enabled: boolean

Whether to show the page

Optional help

help?: string

Optional help text shown under the title

Optional helpUrl

helpUrl?: string

Optional URL describing this page

Optional id

id?: string

Id of the page in the tree/url

settingName

settingName: string

Setting name that's used by REST api to persist settings

Optional title

title?: string

Title of the page in the tree and of the page when displayed

type

type: string

Type is used to determine node type in the setting tree

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc