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

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

import type { ReactNode } from 'react';
import type { UseExpandedOptions, UseExpandedState, IdType } from './ReactTable';
import type { DataType, StateChangeHandler } from './DataType';
/** Type interface for expanded rows options.
 * @category Options */
export interface ExpandedOptions<Data extends DataType> extends UseExpandedOptions<Data> {
    /** Initial settings of expanded rows. */
    initialState?: Partial<UseExpandedState<Data>>;
    /** This string is used as the key to detect
     * manual expanded state on any given row.
     * @default "expanded"
     *
     * The row with ('expanded': true) will always be expanded. */
    manualExpandedKey?: IdType<Data>;
    /** Count expanded sub-rows while calculating rows on a page.
     *  @default true  */
    paginateExpandedRows?: boolean;
    /** Expanded rows are rendered like normal rows.
     * @default true */
    expandSubRows?: boolean;
    /** Reset expanded rows when data changes.
     * @default true */
    autoResetExpanded?: boolean;
    /** Custom method to extract sub-rows from a given row. */
    getSubRows?: (rowData: Data, relativeIndex: number) => Data[];
    /** Callback executed when rows are expanded or collapsed.
     *  The function must be wrapped in useCallback hook. */
    onStateChange?: StateChangeHandler<UseExpandedState<Data>>;
    /** Indicator for collapsed row.
     * @default →
     * @category Custom Component */
    collapsedIndicator?: ReactNode;
    /** Indicator for expanded row.
     * @default ↓
     * @category Custom Component */
    expandedIndicator?: ReactNode;
}
export default ExpandedOptions;