import * as React from 'react'; import { Column } from 'react-table'; import type { IdType, PluginHook } from 'react-table'; import type { DataTableInstance, DataTableOptions, DataTableState, DataTableColumn, DataTableRow } from '../types'; import { MenuItemProps } from '../../MenuItem'; /** * DataTable Context */ declare const DataTableContext: React.Context>; /** * DataTable Consumer */ declare const DataTableConsumer: React.Consumer>; /** * Backyard React Data Table Provider * * Provides values to children and handles state management of the `DataTable`. */ declare const DataTableProvider: ({ children, columns: columnsProp, data, enableSortBy, enableRowSelection, enableRowExpansion, enableFilters, enableSearch, enableZebraStripes, disableFooter, disableFuzzyHighlight, disableScrollbar, inverseHeader, globalFilter, filters, sortBy, pageIndex, pageSize, rowsPerPageOptions, initialState, options, plugins, filterTypes: filterTypesProp, defaultColumn: defaultColumnProp, selectedRowIds, expanded, menuItems, showToolbar, showFilters: showFiltersProp, showSearch: showSearchProp, toolbar, size, shape: shapeProp, onSelect, onTableUpdate, ...override }: DataTableProviderProps) => React.ReactElement, string | React.JSXElementConstructor>; declare type ColumnWidths = { width?: DataTableColumn['width']; minWidth?: DataTableColumn['minWidth']; maxWidth?: DataTableColumn['maxWidth']; totalWidth?: DataTableColumn['totalWidth']; }; declare type DataTableProviderOverrideProps = 'columns' | 'enableSearch' | 'enableFilters' | 'showToolbar'; /** * Context values that can be passed to children via * * `const context = React.useContext(DataTableContext)` */ interface DataTableContextValues extends DataTableInstance { enableSortBy: DataTableProviderProps['enableSortBy']; enableRowSelection: DataTableProviderProps['enableRowSelection']; enableRowExpansion: DataTableProviderProps['enableRowExpansion']; enableZebraStripes: DataTableProviderProps['enableZebraStripes']; disableFooter: DataTableProviderProps['disableFooter']; disableFuzzyHighlight: DataTableProviderProps['disableFuzzyHighlight']; disableScrollbar: DataTableProviderProps['disableScrollbar']; inverseHeader: DataTableProviderProps['inverseHeader']; toolbar: DataTableProviderProps['toolbar']; rowsPerPageOptions: DataTableProviderProps['rowsPerPageOptions']; selectedRowIds: DataTableProviderProps['selectedRowIds']; expanded: DataTableProviderProps['expanded']; pageIndex: DataTableProviderProps['pageIndex']; pageSize: DataTableProviderProps['pageSize']; onSelect?: DataTableProviderProps['onSelect']; getColumnWidths?: (column: Column) => ColumnWidths; size: DataTableProviderProps['size']; shape: DataTableProviderProps['shape']; /** * `react-table` options */ options: DataTableProviderProps['options']; /** * Enables the filter toggle switch */ enableFilters: boolean; /** * Enables the search toggle switch */ enableSearch: boolean; /** * The menu items data structure */ menuItems: MenuItemProps[]; /** * Show the filters for the table. */ showFilters: boolean; /** * Show the search for the table. */ showSearch: boolean; /** * Enables the toolbar to be visible */ showToolbar: boolean; /** * Sets the value for the showFilters property. */ setShowFilters: (boolean: any) => void; /** * Sets the value for the showSearch property. */ setShowSearch: (boolean: any) => void; } interface TableEventInfo { table: DataTableInstance; state: DataTableState; ids: Record, boolean>; rows: DataTableRow[]; selected: DataTableRow[]; unselected: DataTableRow[]; } interface DataTableProviderProps extends Omit, DataTableProviderOverrideProps> { /** * React Children to provide context to */ children: React.ReactNode; columns: Array | { Header?: string; accessor?: string; }>; data: Data[]; enableSortBy?: boolean; enableRowExpansion?: boolean; enableRowSelection?: boolean; enableZebraStripes?: boolean; disableFooter?: boolean; disableFuzzyHighlight?: boolean; disableScrollbar?: boolean; globalFilter?: DataTableState['globalFilter']; filters?: DataTableState['filters']; sortBy?: DataTableState['sortBy']; inverseHeader?: boolean; rowsPerPageOptions?: number[]; options?: Partial>; initialState?: Partial>; plugins?: PluginHook[]; defaultColumn?: Partial>; filterTypes?: Record; selectedRowIds?: Record, boolean>; expanded?: Record, boolean>; pageIndex?: number; pageSize?: number; showSearch?: boolean; showFilters?: boolean; onSelect?: (info: TableEventInfo) => void; onTableUpdate?: (table: DataTableInstance) => void; /** * Enables the filter toggle switch */ enableFilters?: boolean; /** * Enables the search toggle switch */ enableSearch?: boolean; /** * The menu items data structure */ menuItems?: MenuItemProps[]; /** * Enables the toolbar to be visible */ showToolbar?: boolean; /** * Size of each cell */ size?: 'small' | 'medium' | 'large' | 'custom'; /** * Shape of the whole table */ shape?: 'rounded' | 'squared'; /** * Override props for `DataTableProvider` to either override current functionality * or provide new context to children. */ override?: object; } export { DataTableProvider, DataTableContext, DataTableConsumer }; export type { DataTableContextValues, DataTableProviderProps }; export default DataTableProvider;