Function: Dashboard()
Dashboard(
__namedParameters):Element
Defined in: Dashboard.tsx:145
Parameters
| Parameter | Type | Description |
|---|---|---|
__namedParameters | { cardCatalog?: CardCatalogItem[]; clickableCardFilter?: (card) => boolean; currency?: string; detailMode?: "single" | "multi"; detailSlotHeight?: number; editable?: boolean; filters?: DashboardFilter[]; headerChildren?: ReactNode; loading?: boolean; onCancelEdit?: () => void; onCardSelect?: (key, card) => void; onEditingGridChange?: (grid) => void; onFiltersChange?: (filters) => void; onSaveAsNewTemplate?: (template) => void; onSaveLayout?: (template) => void; renderCardDetail?: (card, close) => ReactNode; selectedCardKey?: string | string[] | null; selectedTemplate?: DashboardTemplate; showFilters?: boolean; sx?: ThemeUIStyleObject<WidenedTheme>; templates?: DashboardTemplate[]; } | - |
__namedParameters.cardCatalog? | CardCatalogItem[] | Card types available when adding a card (e.g. from API). Omit to use default catalog. |
__namedParameters.clickableCardFilter? | (card) => boolean | When provided, only cards for which this returns true are clickable. Defaults to all non-sectionDivider cards. |
__namedParameters.currency? | string | ISO 4217 currency code (e.g. "BRL", "USD", "EUR"). Applied to all cards with numberType="currency". Card-level currency takes precedence. Defaults to "BRL". |
__namedParameters.detailMode? | "single" | "multi" | 'single' (default): one slot at a time. 'multi': each card gets its own independent slot. |
__namedParameters.detailSlotHeight? | number | Number of grid rows for the detail slot. Defaults to 12 (384 px at rowHeight=32). |
__namedParameters.editable? | boolean | - |
__namedParameters.filters? | DashboardFilter[] | - |
__namedParameters.headerChildren? | ReactNode | - |
__namedParameters.loading? | boolean | - |
__namedParameters.onCancelEdit? | () => void | - |
__namedParameters.onCardSelect? | (key, card) => void | Called whenever the selected card key changes (controlled and uncontrolled). key is the new selection; card is the first selected card or null when closed. |
__namedParameters.onEditingGridChange? | (grid) => void | Called whenever the internal editing grid changes. Receives null when edit mode exits. |
__namedParameters.onFiltersChange? | (filters) => void | - |
__namedParameters.onSaveAsNewTemplate? | (template) => void | - |
__namedParameters.onSaveLayout? | (template) => void | - |
__namedParameters.renderCardDetail? | (card, close) => ReactNode | Render a detail slot below the clicked card's row. Receives the card and a close callback. |
__namedParameters.selectedCardKey? | string | string[] | null | Controlled selection. When provided, DashboardContent uses this value instead of its own useState. Supply onCardSelect to handle changes. Supports a single key (string) or multiple keys (string[]) when detailMode='multi'. Omit entirely for uncontrolled behavior (default). |
__namedParameters.selectedTemplate? | DashboardTemplate | - |
__namedParameters.showFilters? | boolean | When false, the internal filter bar is not rendered. Useful when filters are managed in an external UI. Defaults to true. |
__namedParameters.sx? | ThemeUIStyleObject<WidenedTheme> | Style overrides applied to the outer container. Use to adjust padding or spacing to fit a surrounding layout. |
__namedParameters.templates? | DashboardTemplate[] | - |
Returns
Element