Documentation / @zerotal/admin / index / AdminPanelHost
Interface: AdminPanelHost
Defined in: admin/src/plugin.ts:249
The panel's write surface, bound into the container as admin.panel.
Contributors should declare their own minimal copy of the members they use rather than importing this type, so they depend on the admin package at build time not at all.
Methods
enabled()
enabled(
id):boolean
Defined in: admin/src/plugin.ts:255
Whether the app has left this contributor switched on. Check it first and
return early — plugins: { monitor: false } in config/admin.ts turns a
contributor off without uninstalling its provider.
Parameters
id
string
Returns
boolean
page()
page(
contribution):void
Defined in: admin/src/plugin.ts:256
Parameters
contribution
Returns
void
console()
console(
contribution):void
Defined in: admin/src/plugin.ts:261
Add a table-and-actions page described as data. The cheaper door — no component, no JSX, no dependency on Flow.
Parameters
contribution
Returns
void
widget()
widget(
contribution):void
Defined in: admin/src/plugin.ts:262
Parameters
contribution
Returns
void
navItem()
navItem(
contribution):void
Defined in: admin/src/plugin.ts:263
Parameters
contribution
Returns
void
searchProvider()
searchProvider(
provider):void
Defined in: admin/src/plugin.ts:264
Parameters
provider
Returns
void
topbarSlot()
topbarSlot(
slot):void
Defined in: admin/src/plugin.ts:265
Parameters
slot
Returns
void
userMenuItem()
userMenuItem(
item):void
Defined in: admin/src/plugin.ts:266
Parameters
item
Returns
void
renderHook()
renderHook(
name,hook):void
Defined in: admin/src/plugin.ts:271
Render into a named position in the panel's chrome — a banner above every
table, a notice under every form. See RenderHookName for the positions.
Parameters
name
string
hook
(context) => string | HtmlNode | null
Returns
void