ClickyTable

API reference and demos for ClickyTable.

Source

Import

import { ClickyTable } from "@flanksource/clicky-ui/data";

Demos

Rich Document · Open in Storybook

Json String Payload · Open in Storybook

Markdown Blocks · Open in Storybook

The props table documents the component-specific surface. Standard DOM attributes inherited from React, such as className, event handlers, and accessibility attributes, may also be accepted when the component’s prop type extends a native element.

Props

Prop	Type	Default	Description
autoFilter	boolean	—	Enable generated filters for filterable columns.
cellFilters	Record<string, Record<string, CellFilterMode>>	—	—
cellRenderers	ClickyCellRenderers	—	—
columns*	ClickyColumn[]	—	Clicky table column definitions.
detailDialogSize	enum	—	Dialog size when `detailStyle` is "dialog".
detailDialogTitle	ClickyRowDetailTitle	—	Dialog title when `detailStyle` is "dialog".
detailStyle	enum	—	How `renderRowDetail` content is surfaced when a row is clicked.
externalFilters	FilterBarFilter[]	—	Extra FilterBar controls rendered before generated filters.
getTableRowHref	ClickyTableRowHref	—	Optional href factory for row links.
hiddenColumns	string[]	—	Column names retained in raw rows but omitted from the table.
infinite	DataTableInfinite	—	Server-driven infinite scroll over rows the caller has accumulated.
isTableRowClickable	ClickyTableRowPredicate	—	Predicate controlling whether a row is clickable.
loading	boolean	—	Shows the table loading bar without replacing existing rows.
menuActions	DataTableMenuAction[]	—	Extra actions rendered in the table menu.
onCellFilterChange	(…) => …	—	—
onSortChange	(…) => …	—	—
onTableRowClick	ClickyTableRowClick	—	Called when a row is clicked.
pagination	DataTablePagination	—	Pagination footer configuration.
renderRowCard	ClickyRowCardRenderer	—	—
renderRowDetail	ClickyRowDetailRenderer	—	Host row-detail renderer, given raw values keyed by column name.
rows*	ClickyRow[]	—	Clicky table rows.
rowSelection	ClickyTableRowSelection	—	Controlled multi-row selection.
search	FilterBarSearchProps	—	Dedicated search input rendered in the table's FilterBar.
sort	SortState | null	—	—
timeRange	FilterBarRangeProps	—	Time-range control rendered in the table's FilterBar.