///
import type { DataTableBaseProps, DataTableBaseRef } from './DataTableBase';
import type { DataTableProviderProps } from './DataTableProvider';
import { MenuItemProps } from '../MenuItem';
/**
* Backyard React Data Table
*
* Examples:
*
* - [DataTable](https://backyard.lowes.com/Components/DataTable)
*
* API:
*
* - [DataTable API](https://backyard.lowes.com/ComponentsAPI/DataTable)
*/
declare const DataTable: ({ children, columns, data, enableSortBy, enableRowSelection, enableRowExpansion, enableFilters, enableSearch, enableZebraStripes, disableFooter, disableFuzzyHighlight, disableScrollbar, menuItems, showToolbar, inverseHeader, toolbar, filters, sortBy, globalFilter, pageIndex, pageSize, rowsPerPageOptions, initialState, options, plugins, filterTypes, defaultColumn, selectedRowIds, expanded, size, shape, showFilters, showSearch, onSelect, onTableUpdate, override, ...props }: DataTableProps) => JSX.Element;
declare type DataTableRef = DataTableBaseRef;
declare type DataTableOverrideProps = 'size' | 'onSelect';
interface DataTableProps extends Omit {
/**
* The column data structure
*/
columns: DataTableProviderProps['columns'];
/**
* The table data structure
*/
data: DataTableProviderProps['data'];
/**
* Enables the filter toggle switch
*/
enableFilters?: boolean;
/**
* Enables the search toggle switch
*/
enableSearch?: boolean;
/**
* List of menu items to provide to default menu
*/
menuItems?: MenuItemProps[];
/**
* Override props for `DataTableProvider` to either override current functionality
* or provide new context to children.
*/
override?: DataTableProviderProps['override'];
/**
* Whether or not the sorting feature is enabled
*/
enableSortBy?: DataTableProviderProps['enableSortBy'];
/**
* Whether or not the row expansion feature is enabled
*/
enableRowExpansion?: DataTableProviderProps['enableRowExpansion'];
/**
* Whether or not the row selection feature is enabled
*/
enableRowSelection?: DataTableProviderProps['enableRowSelection'];
/**
* Whether or not the row alternates zebra stripe background colors
*/
enableZebraStripes?: DataTableProviderProps['enableZebraStripes'];
/**
* Whether or not the footer (pagination) is disabled
*/
disableFooter?: DataTableProviderProps['disableFooter'];
/**
* Whether or not the fuzzy highlight effect on the column values is disabled
*/
disableFuzzyHighlight?: DataTableProviderProps['disableFuzzyHighlight'];
/**
* Whether or not the default scrollbars within the data table are disabled
*
* Prevents overflowing so the root app must handle scrolling on overflow
*/
disableScrollbar?: DataTableProviderProps['disableScrollbar'];
/**
* Use to provide a list of column filter rules
*
* Can be used for initial value and will react to changes externally
*/
filters?: DataTableProviderProps['filters'];
/**
* Use to provide a list of sorting rules
*
* Can be used for initial value and will react to changes externally
*/
sortBy?: DataTableProviderProps['sortBy'];
/**
* Use to provide a global filter
*
* Can be used for initial value and will react to changes externally
*/
globalFilter?: DataTableProviderProps['globalFilter'];
/**
* Provide additional components to the `DataTable` toolbar here
*/
toolbar?: DataTableProviderProps['toolbar'];
/**
* Whether or not the header's background color is inversed
*/
inverseHeader?: DataTableProviderProps['inverseHeader'];
/**
* List of options for row count per page to provide to user through the pagination
*/
rowsPerPageOptions?: DataTableProviderProps['rowsPerPageOptions'];
/**
* Options for `react-table`
*
* See `react-table` documentation for more info
* @link https://react-table.tanstack.com/docs/api/overview
*/
options?: DataTableProviderProps['options'];
/**
* Initial state for `react-table` to use
*
* See `react-table` documentation for more info
* @link https://react-table.tanstack.com/docs/api/overview
*/
initialState?: DataTableProviderProps['initialState'];
/**
* Use to modify or to add `react-table` plugin hooks
*
* See `react-tabl` documentation for more info
* @link https://react-table.tanstack.com/docs/api/overview
*/
plugins?: DataTableProviderProps['plugins'];
/**
* Use to alter/expand the behavior of the default column
*/
defaultColumn?: DataTableProviderProps['defaultColumn'];
/**
* Use to alter/expand the available set of filter type components
*/
filterTypes?: DataTableProviderProps['filterTypes'];
/**
* Use to rovide a list of rows that are selected
*
* Can be used for initial list and will react to external changes
*/
selectedRowIds?: DataTableProviderProps['selectedRowIds'];
/**
* Use to provide a list of rows that are expanded
*
* Can be used for initial list and will react to external changes
*/
expanded?: DataTableProviderProps['expanded'];
/**
* Use to provide the page index
*
* Can be used for initial page index and will react to external changes
*/
pageIndex?: DataTableProviderProps['pageIndex'];
/**
* Use to provide the page size
*
* Can be used for initial page size and will react to external changes
*/
pageSize?: DataTableProviderProps['pageSize'];
/**
* Enables column level filters
*/
showFilters?: DataTableProviderProps['showFilters'];
/**
* Enables the global filter feature
*/
showSearch?: DataTableProviderProps['showSearch'];
/**
* Triggers whenever a row is selected
*
* Only useful if `enableRowSelection` is true
*/
onSelect?: DataTableProviderProps['onSelect'];
/**
* Triggers whenever `react-table`'s state is update
*
* This happens when the user interacts with the table through
* a filter, sort, pagination change, or changes the rows per page
*/
onTableUpdate?: DataTableProviderProps['onTableUpdate'];
/**
* Enables the toolbar to be visible
*/
showToolbar?: boolean;
/**
* Size of each cell
*/
size?: DataTableProviderProps['size'];
/**
* Shape of the whole data table
*/
shape?: DataTableProviderProps['shape'];
}
export { DataTable };
export type { DataTableProps, DataTableRef };
export default DataTable;