@vitorlans/react-table-ui/dist/types/RowSelectOptions.d.ts

Out-of-the-box UI for React-Table 7

import type { FC } from 'react';
import type { UseRowSelectOptions, UseRowSelectState, TableToggleCommonProps, IdType } from './ReactTable';
import type { DataType, StateChangeHandler } from './DataType';
/** Type interface for RowSelect options.
 * @category Options */
export interface RowSelectOptions<Data extends DataType> extends UseRowSelectOptions<Data> {
    /** Initial settings of row-select.
     * @example
     * ```
     * { selectedRowIds: { [rowId]: boolean } }
     * ```
     */
    initialState?: Partial<UseRowSelectState<Data>>;
    /** Disable row selection.
     * @default false */
    disableRowSelect?: boolean;
    /** Key is found on the original data row, and it is true,
     *  this row will be manually selected.
     * @default 'isSelected' */
    manualRowSelectedKey?: IdType<Data>;
    /** Reset row-selection when data changes.
     * @default true */
    autoResetSelectedRows?: boolean;
    /** Allow sub-rows to be selected.
     * @default false */
    selectSubRows?: boolean;
    /** Callback executed when rows are selected or deselected.
     *  The function must be wrapped in useCallback hook. */
    onStateChange?: StateChangeHandler<UseRowSelectState<Data>>;
    /** Component to render to denote row selection
     * @category Custom Component */
    Component?: RowSelectComponent;
}
export declare type RowSelectComponent = FC<TableToggleCommonProps>;
export default RowSelectOptions;