bastilian-tabletools
    Preparing search index...

    Function TableToolsTable

    • Wrapper around a table variant and the useTableTools hook. Always mounts a TableStateProvider so table state is available to nested hooks.

      Parameters

      • props: {
            columns: any[];
            filters?: any[];
            items: any[];
            loading?: boolean;
            options?: object;
            paginationProps?: object;
            tableBodyProps?: object;
            tableHeaderProps?: object;
            tableToolbarProps?: object;
            tableToolsTableVariant?: string;
            toolbarProps?: object;
            total?: number;
        }

        Component Props

        • columns: any[]

          An array of column objects to render items with

        • Optionalfilters?: any[]

          an array of filters

        • items: any[]

          An array or (async) function that returns an array of items to render or an async function to call with the tableState and serialised table state

        • Optionalloading?: boolean

          Custom loading condition

        • Optionaloptions?: object

          An object of options that will be passed along to the useTableTools hook

        • OptionalpaginationProps?: object

          Props to be passed on the Pagination component

        • OptionaltableBodyProps?: object

          Props to be passed on the TableBody component

        • OptionaltableHeaderProps?: object

          Props to be passed on the TableHeader component

        • OptionaltableToolbarProps?: object

          Props to be passed on the TableToolbar (bottom toolbar) component

        • OptionaltableToolsTableVariant?: string

          Variant key from variants (default: 'table')

        • OptionaltoolbarProps?: object

          Props to be passed on the PrimaryToolbar component

        • Optionaltotal?: number

          Number of total items available

      Returns ReactElement<any, string | JSXElementConstructor<any>>

      Selected table variant with shared modals, wrapped in a TableStateProvider

    Index