Skip to main content
zerotal

Documentation

Documentation / @zerotal/admin / index / ConsoleContribution

Interface: ConsoleContribution

Defined in: admin/src/plugin.ts:160

A read-and-act page described as data rather than built as a component.

Most packages want the same page: some tables, a few buttons, no bespoke layout. Describing that instead of rendering it means the contributing package needs no JSX, no @zerotal/flow dependency and no build configuration — the panel owns the markup, so every console also looks like the rest of the admin without trying to.

Reach for PageContribution instead when a page genuinely needs its own component: charts, a custom layout, its own reactive state.

Properties

slug

slug: string

Defined in: admin/src/plugin.ts:162

Path under the panel root, without leading slash.

title

title: string

Defined in: admin/src/plugin.ts:163

ability

ability: string

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

Ability required to see the nav entry and open the route.

tabs

tabs: ConsoleTab[]

Defined in: admin/src/plugin.ts:166

optional navigationLabel?: string

Defined in: admin/src/plugin.ts:167

optional navigationIcon?: string

Defined in: admin/src/plugin.ts:168

optional navigationGroup?: string

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

optional navigationSort?: number

Defined in: admin/src/plugin.ts:170

showInNavigation?

optional showInNavigation?: boolean

Defined in: admin/src/plugin.ts:171

optional navigationBadge?: () => string | number | Promise<string | number | null> | null

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

A count pill beside the sidebar entry. Failures are swallowed.

Returns

string | number | Promise<string | number | null> | null

optional navigationBadgeColor?: BadgeTone

Defined in: admin/src/plugin.ts:175

Tone of the navigation badge.