Skip to content

plugin-api/SettingsPanelRegistry#

useSettingsPanels()#

function useSettingsPanels(): SettingsPanelDef[];

React hook that returns all registered settings panels, re-rendering on changes.

Returns#

SettingsPanelDef[]


settingsPanelRegistry#

const settingsPanelRegistry: SettingsPanelRegistry;

SettingsPanelDef#

Properties#

component#

component: ComponentType;

icon?#

optional icon?: ComponentType<{
  fontSize?: string;
}>;

id#

id: string;

isVisible?#

optional isVisible?: () => boolean;

Optional predicate that determines whether this panel tab should be shown.

Returns#

boolean

label#

label: string;

order#

order: number;