Dashboard Config

Type: FluiKitDashboardConfig.

Properties

Property	Type	Required	Description
`enabled`	`boolean`	No	Enables dashboard rendering.
`title`	`string`	No	Dashboard title.
`description`	`string`	No	Dashboard description.
`cards`	`FluiKitDashboardCardConfig[]`	No	Dashboard cards.
`grid`	`FluiKitGridConfig`	No	Card grid config.
`renderer`	`string`	No	Custom dashboard renderer key.
`className`	`string`	No	Dashboard class name.

Card properties

Property	Type	Required	Description
`key`	`string`	Yes	Card key.
`label`	`string`	No	Card label.
`valueFrom`	`string`	No	Data path for card value.
`renderer`	`string`	No	Custom card renderer key.
`endpoint`	`FluiKitEndpointItem`	No	Endpoint for card value.
`format`	`"number" \| "currency" \| "percent" \| "text" \| "custom"`	No	Value format.
`icon`	`string`	No	Iconify icon.
`className`	`string`	No	Card class name.

Nothing renders if enabled is false, or if there are no cards and no renderer.

Example

dashboard: {
  enabled: true,
  cards: [
    { key: "totalUsers", label: "Users", valueFrom: "summary.totalUsers", format: "number" },
    { key: "activeUsers", label: "Active", valueFrom: "summary.activeUsers", format: "number" }
  ]
}