@helix-x/datagrid-ui - v0.1.2
    Preparing search index...

    Interface UseSelectionModelResult<T>

    What useSelectionModel returns.

    interface UseSelectionModelResult<T> {
        allVisibleSelected: boolean;
        clear: () => void;
        getSelectedRows: () => T[];
        isSelected: (id: RowId) => boolean;
        selectAllVisible: () => void;
        selectedIds: Set<RowId>;
        someVisibleSelected: boolean;
        toggleAllVisible: () => void;
        toggleRow: (id: RowId, index: number, shiftKey: boolean) => void;
    }

    Type Parameters

    • T

      The row type.

    Index
    allVisibleSelected clear getSelectedRows isSelected selectAllVisible selectedIds someVisibleSelected toggleAllVisible toggleRow
    allVisibleSelected: boolean

    True when every row currently on screen is selected.

    clear: () => void

    Deselect everything, including rows on other pages.

    getSelectedRows: () => T[]

    The selected rows that are currently loaded.

    isSelected: (id: RowId) => boolean

    Whether one id is selected.

    selectAllVisible: () => void

    Select every row on the current page.

    selectedIds: Set<RowId>

    Every selected id, including rows on pages that are not loaded.

    someVisibleSelected: boolean

    True when some, but not all, visible rows are selected.

    toggleAllVisible: () => void

    Select every visible row, or deselect them if all are already selected.

    toggleRow: (id: RowId, index: number, shiftKey: boolean) => void

    Toggle one row.

    Type Declaration

      • (id: RowId, index: number, shiftKey: boolean): void

      • Parameters

        • id: RowId

          The row to toggle.

        • index: number

          Its index in the loaded page, used as the shift anchor.

        • shiftKey: boolean

          Extend from the last toggled row instead of toggling one.

        Returns void

    Settings
    Member Visibility

    On This Page
    Properties