hooks/usePluginAppBar#

PluginAppBarProvider()#

function PluginAppBarProvider(props): Element;

Parameters#

Parameter	Type
`props`	{ `children`: `ReactNode`; }
`props.children`	`ReactNode`

Returns#

Element

usePluginAppBar()#

function usePluginAppBar(): {
  clearAppBar: () => void;
  setAppBar: (config) => void;
};

Hook for plugins to configure their AppBar content

Returns#

{
  clearAppBar: () => void;
  setAppBar: (config) => void;
}

clearAppBar#

clearAppBar: () => void;

Returns#

void

setAppBar#

setAppBar: (config) => void;

Parameters#

Parameter	Type
`config`	`PluginAppBarConfig`

Returns#

void

Example#

const SaveLoadButtons = useSaveLoadButtons({ ... })
const { setAppBar } = usePluginAppBar()

useEffect(() => {
  setAppBar({
    form: <SaveLoadButtons />,
    shortcut: <EditViewSwitch />
  })
}, [])

PluginAppBarConfig#

Properties#

form?#

optional form?: ReactNode;

Custom form content (center area)

shortcut?#

optional shortcut?: ReactNode;

Custom shortcut content (right area)