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

    Interface UseGridStateResult

    What useGridState returns.

    interface UseGridStateResult {
        clear: () => void;
        hasSavedState: boolean;
        initial: PersistedGridState | undefined;
        saveColumns: (
            columns: {
                hidden: string[];
                order: string[];
                pinned: Record<string, Pinned>;
                widths: Record<string, number>;
            },
        ) => void;
        saveFilters: (filters: FilterModelMap) => void;
        savePageSize: (pageSize: number) => void;
        saveSort: (sort: SortModelItem[]) => void;
    }
    Index
    clear hasSavedState initial saveColumns saveFilters savePageSize saveSort
    clear: () => void

    Delete the saved state entirely.

    hasSavedState: boolean

    Whether anything was restored on mount.

    initial: PersistedGridState | undefined

    The restored state, read once on mount and never re-read — so it is safe to use as a useState initial value. undefined when nothing was saved or the saved schema version did not match.

    saveColumns: (
        columns: {
            hidden: string[];
            order: string[];
            pinned: Record<string, Pinned>;
            widths: Record<string, number>;
        },
    ) => void

    Persist the column layout.

    saveFilters: (filters: FilterModelMap) => void

    Persist the filter model.

    savePageSize: (pageSize: number) => void

    Persist the page size.

    saveSort: (sort: SortModelItem[]) => void

    Persist the sort model.

    Settings
    Member Visibility

    On This Page
    Properties