Circle V2 API Docs
    Preparing search index...

    Type Alias DataTableProps<TData>

    DataTableProps: {
        columns: ColumnDef<TData, any>[];
        data: TData[];
        expanded?: ExpandedState;
        grouping?: GroupingState;
        initialState?: Partial<TableState>;
        isRowActive?: (row: Row<TData>) => boolean;
        manualSorting?: boolean;
        onExpandedChange?: OnChangeFn<ExpandedState>;
        onRowClick?: (row: Row<TData>) => void;
        onSortingChange?: (updater: Updater<SortingState>) => void;
        renderGroupRow?: (
            args: { columnCount: number; row: Row<TData> },
        ) => ReactNode;
        state?: Partial<TableState>;
        subRowIndent?: number;
    } & Omit<React.ComponentProps<typeof Table.Root>, "children">

    Type Parameters

    • TData

    Type Declaration

    • columns: ColumnDef<TData, any>[]
    • data: TData[]
    • Optionalexpanded?: ExpandedState

      Controlled expanded state — which group rows are open.

    • Optionalgrouping?: GroupingState

      Array of column IDs to group rows by. When set, TanStack groups leaf rows and renders a group header row per unique value. Groups are collapsed by default unless expanded or initialState.expanded specifies otherwise.

    • OptionalinitialState?: Partial<TableState>
    • OptionalisRowActive?: (row: Row<TData>) => boolean

      Returns true if the row should be visually highlighted as "active" (e.g. selected in a master-detail layout).

    • OptionalmanualSorting?: boolean

      When true, table does not sort data client-side; use for server-sorted data.

    • OptionalonExpandedChange?: OnChangeFn<ExpandedState>
    • OptionalonRowClick?: (row: Row<TData>) => void

      Called when a body row is clicked. Not fired for group rows, buttons, links, or elements with role="button".

    • OptionalonSortingChange?: (updater: Updater<SortingState>) => void
    • OptionalrenderGroupRow?: (args: { columnCount: number; row: Row<TData> }) => ReactNode

      Optional custom renderer for group header rows. Receives the grouped Row and a visible-column count (for colSpan). If omitted, a default header with chevron, group value, and subrow count is rendered.

    • Optionalstate?: Partial<TableState>
    • OptionalsubRowIndent?: number

      Left-padding applied to the first cell of each sub-row, multiplied by the row's depth (in Chakra spacing units). Default: 6 (≈ 1.5rem per level). Set to 0 to disable nesting indentation.

    Settings

    Member Visibility