Documentation / @zerotal/admin / index / Panel

Class: Panel

Defined in: admin/src/Panel.ts:53

Constructors

Constructor

new Panel(): Panel

Returns

Panel

Methods

default()

static default(): PanelInstance

Defined in: admin/src/Panel.ts:59

The panel every app starts with, created on first use.

Returns

PanelInstance

make()

static make(id, config?): PanelInstance

Defined in: admin/src/Panel.ts:72

Create (or reconfigure) an additional panel. Give it a path of its own — two panels sharing a prefix cannot be told apart from a URL.

Parameters

id

string

config?

Partial<AdminConfigShape> = {}

Returns

PanelInstance

get()

static get(id): PanelInstance | undefined

Defined in: admin/src/Panel.ts:84

Resolve a panel by id.

Parameters

id

string

Returns

PanelInstance | undefined

all()

static all(): PanelInstance[]

Defined in: admin/src/Panel.ts:89

Every registered panel, the default one first.

Returns

PanelInstance[]

current()

static current(): PanelInstance

Defined in: admin/src/Panel.ts:103

The panel the current request belongs to — the one whose path is the longest matching prefix of the request URL. Off-request (boot, CLI, queue workers, WebSocket actions) this is the default panel, which is also the right answer for the overwhelmingly common single-panel app.

Pages generated for a specific panel hold that instance directly rather than asking here, so their WebSocket actions stay on the right panel too.

Returns

PanelInstance

forPath()

static forPath(path): PanelInstance

Defined in: admin/src/Panel.ts:116

The panel owning path, or the default panel when none claims it.

Parameters

path

string

Returns

PanelInstance

reset()

static reset(): void

Defined in: admin/src/Panel.ts:127

Forget every panel (tests).

Returns

void

configure()

static configure(config): void

Defined in: admin/src/Panel.ts:133

Parameters

config

Partial<AdminConfigShape>

Returns

void

config()

static config(): AdminConfigShape

Defined in: admin/src/Panel.ts:137

Returns

AdminConfigShape

register()

static register(...resources): void

Defined in: admin/src/Panel.ts:141

Parameters

resources

...typeof Resource[]

Returns

void

resources()

static resources(): typeof Resource[]

Defined in: admin/src/Panel.ts:145

Returns

typeof Resource[]

widgets()

static widgets(...widgets): void

Defined in: admin/src/Panel.ts:149

Parameters

widgets

...DashboardWidget[]

Returns

void

dashboardWidgets()

static dashboardWidgets(): DashboardWidget[]

Defined in: admin/src/Panel.ts:153

Returns

DashboardWidget[]

notifications()

static notifications(provider): void

Defined in: admin/src/Panel.ts:157

Parameters

provider

NotificationProvider

Returns

void

notificationProvider()

static notificationProvider(): NotificationProvider | undefined

Defined in: admin/src/Panel.ts:161

Returns

NotificationProvider | undefined

auth()

static auth(config): void

Defined in: admin/src/Panel.ts:165

Parameters

config

AdminAuthConfig

Returns

void

authConfig()

static authConfig(): AdminAuthConfig | undefined

Defined in: admin/src/Panel.ts:169

Returns

AdminAuthConfig | undefined

find()

static find(slug): typeof Resource | undefined

Defined in: admin/src/Panel.ts:173

Parameters

slug

string

Returns

typeof Resource | undefined

pages()

static pages(...pages): void

Defined in: admin/src/Panel.ts:177

Parameters

pages

...AdminPageClass[]

Returns

void

registeredPages()

static registeredPages(): PanelPage[]

Defined in: admin/src/Panel.ts:181

Returns

PanelPage[]

findPage()

static findPage(slug): PanelPage | undefined

Defined in: admin/src/Panel.ts:185

Parameters

slug

string

Returns

PanelPage | undefined

plugin()

static plugin(...plugins): Promise<void>

Defined in: admin/src/Panel.ts:189

Parameters

plugins

...AdminPlugin[]

Returns

Promise<void>

pluginEnabled()

static pluginEnabled(id): boolean

Defined in: admin/src/Panel.ts:193

Parameters

id

string

Returns

boolean

host()

static host(): AdminPanelHost

Defined in: admin/src/Panel.ts:197

Returns

AdminPanelHost

consoles()

static consoles(): ConsoleContribution[]

Defined in: admin/src/Panel.ts:201

Returns

ConsoleContribution[]

findConsole()

static findConsole(slug): ConsoleContribution | undefined

Defined in: admin/src/Panel.ts:205

Parameters

slug

string

Returns

ConsoleContribution | undefined

contributedWidgets()

static contributedWidgets(): WidgetContribution[]

Defined in: admin/src/Panel.ts:209

Returns

WidgetContribution[]

visibleWidgets()

static visibleWidgets(): Promise<DashboardWidget[]>

Defined in: admin/src/Panel.ts:213

Returns

Promise<DashboardWidget[]>

visibleSearchProviders()

static visibleSearchProviders(): Promise<PanelSearchProvider[]>

Defined in: admin/src/Panel.ts:217

Returns

Promise<PanelSearchProvider[]>

visibleTopbarSlots()

static visibleTopbarSlots(): Promise<TopbarSlot[]>

Defined in: admin/src/Panel.ts:221

Returns

Promise<TopbarSlot[]>

visibleUserMenuItems()

static visibleUserMenuItems(): Promise<UserMenuContribution[]>

Defined in: admin/src/Panel.ts:225

Returns

Promise<UserMenuContribution[]>

savedViews()

static savedViews(provider): void

Defined in: admin/src/Panel.ts:229

Parameters

provider

SavedViewProvider

Returns

void

savedViewProvider()

static savedViewProvider(): SavedViewProvider | undefined

Defined in: admin/src/Panel.ts:233

Returns

SavedViewProvider | undefined

media()

static media(provider, options?): void

Defined in: admin/src/Panel.ts:237

Parameters

provider

MediaProvider

options?

disk?

string

Returns

void

mediaDisk()

static mediaDisk(): string | undefined

Defined in: admin/src/Panel.ts:241

Returns

string | undefined

mediaProvider()

static mediaProvider(): MediaProvider | undefined

Defined in: admin/src/Panel.ts:245

Returns

MediaProvider | undefined

roles()

static roles(provider): void

Defined in: admin/src/Panel.ts:249

Parameters

provider

RoleProvider

Returns

void

roleProvider()

static roleProvider(): RoleProvider | undefined

Defined in: admin/src/Panel.ts:253

Returns

RoleProvider | undefined

dashboardLayout()

static dashboardLayout(store): void

Defined in: admin/src/Panel.ts:257

Parameters

store

DashboardLayoutStore

Returns

void

dashboardLayoutStore()

static dashboardLayoutStore(): DashboardLayoutStore | undefined

Defined in: admin/src/Panel.ts:261

Returns

DashboardLayoutStore | undefined

renderHook()

static renderHook(name, hook): void

Defined in: admin/src/Panel.ts:265

Parameters

name

RenderHookName

hook

RenderHook

Returns

void

renderHooks()

static renderHooks(name): RenderHook[]

Defined in: admin/src/Panel.ts:269

Parameters

name

RenderHookName

Returns

RenderHook[]

can()

static can(ability): Promise<boolean>

Defined in: admin/src/Panel.ts:273

Parameters

ability

string | undefined

Returns

Promise<boolean>

navigationBadges()

static navigationBadges(): Promise<Record<string, { text: string; color: string; }>>

Defined in: admin/src/Panel.ts:277

Returns

Promise<Record<string, { text: string; color: string; }>>

static navigation(): NavGroup[]

Defined in: admin/src/Panel.ts:281

Returns

NavGroup[]

visibleNavigation()

static visibleNavigation(): Promise<NavGroup[]>

Defined in: admin/src/Panel.ts:285

Returns

Promise<NavGroup[]>