Skip to main content
zerotal

Documentation


Documentation / @zerotal/admin / index / ConsoleTab

Interface: ConsoleTab

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

One tab of a console — a table, plus what can be done to it.

Properties

key

key: string

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


label

label: string

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


description?

optional description?: string

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

Explanatory line under the heading.


columns

columns: ConsoleColumn[]

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


rows

rows: () => ConsoleRow[] | Promise<ConsoleRow[]>

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

Returns

ConsoleRow[] | Promise<ConsoleRow[]>


rowKey?

optional rowKey?: string

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

Property identifying a row, used for morph keys. Defaults to "id".


rowActions?

optional rowActions?: ConsoleAction[]

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


headerActions?

optional headerActions?: ConsoleHeaderAction[]

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


empty?

optional empty?: string

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

Shown in place of an empty table.


badge?

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

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

A count pill on the tab itself.

Returns

number | Promise<number | null> | null