Clicky

API reference and demos for Clicky.

Source

Import

import { Clicky } 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
cellFilters	Record<string, Record<string, CellFilterMode>>	—	—
cellRenderers	ClickyCellRenderers	—	—
className	string	—	Classes applied to the renderer root.
commandRuntime	ClickyCommandRuntime	—	Runtime used by link-command nodes.
data	string | ClickyDocument | ClickyNode	—	Clicky document, node, or JSON string to render.
dataFormat	enum	—	The format `data` is already in, when the caller fetched it from `url` itself. That view then renders the payload in hand instead of asking the endpoint for the same bytes a second time; every other view still fetches. Without it `data` is a fallback that a fresh fetch replaces.
detailDialogSize	enum	—	Dialog size when `detailStyle` is "dialog" for the first embedded table.
detailDialogTitle	ClickyRowDetailTitle	—	Dialog title when `detailStyle` is "dialog" for the first embedded table.
detailStyle	enum	—	How `renderRowDetail` content is surfaced for the first embedded table.
download	ClickyDownloadOptions	—	Download menu configuration.
externalFilters	FilterBarFilter[]	—	—
getTableRowHref	ClickyTableRowHref	—	Optional href factory for embedded table rows.
hiddenColumns	string[]	—	Column names retained in raw rows but omitted from the first table.
infinite	DataTableInfinite	—	Server-driven infinite scroll for the first embedded table. `data` is expected to already hold every page fetched so far, so this carries only the question of whether to ask for another.
isTableRowClickable	ClickyTableRowPredicate	—	Predicate controlling whether embedded table rows are clickable.
loading	boolean	—	Shows the first embedded table's loading bar without replacing its rows.
menuActions	DataTableMenuAction[]	—	Host actions listed in a table result's overflow menu, ahead of export and debug.
onCellFilterChange	(…) => void	—	—
onSortChange	(…) => void	—	—
onTableRowClick	ClickyTableRowClick	—	Called when an embedded table row is clicked.
pagination	DataTablePagination	—	Pagination footer configuration for the first embedded table.
renderRowCard	ClickyRowCardRenderer	—	—
renderRowDetail	ClickyRowDetailRenderer	—	Host row-detail renderer for the first embedded table.
rowSelection	ClickyTableRowSelection	—	Controlled multi-row selection for the first embedded table.
search	FilterBarSearchProps	—	—
sort	SortState | null	—	Controlled public server sort state for the first embedded table.
timeRange	FilterBarRangeProps	—	Time-range control published into the first embedded table's FilterBar.
url	string	—	Remote URL to fetch when `data` is not provided.
view	ClickyViewConfig	—	Enabled remote view/download formats.