Function useQueryPagination

A hook that provides pagination functionality for querying data.

  • useQueryPagination<FilterData, RowData>(initialValue?, options?): {
        getChipData: (() => Exclude<Partial<Record<keyof RowData, boolean>>, undefined>);
        getFilterData: (() => Exclude<Partial<FilterData>, undefined>);
        getLimit: (() => number);
        getPage: (() => number);
        getSearch: (() => string);
        getSortModel: (() => ListHandlerSortModel<RowData>);
        listProps: {
            chipData: undefined | Partial<Record<keyof RowData, boolean>>;
            fallback: undefined | ((e: Error) => void);
            filterData: undefined | Partial<FilterData>;
            limit: undefined | number;
            onChipsChange: ((data: Partial<Record<keyof RowData, boolean>>) => void);
            onFilterChange: ((data: FilterData) => void);
            onLimitChange: ((limit: number) => void);
            onPageChange: ((page: number) => void);
            onSearchChange: ((search: string) => void);
            onSortModelChange: ((sort: ListHandlerSortModel<RowData>) => void);
            page: undefined | number;
            search: undefined | string;
            sortModel: undefined | ListHandlerSortModel<RowData>;
        };
        setChipData: ((data: Partial<Record<keyof RowData, boolean>>) => void);
        setFilterData: ((data: FilterData) => void);
        setLimit: ((limit: number) => void);
        setPage: ((page: number) => void);
        setSearch: ((search: string) => void);
        setSortModel: ((sort: ListHandlerSortModel<RowData>) => void);
    }

  • Type Parameters

    • FilterData extends {} = any

      The type of filter data.

    • RowData extends IRowData = any

      The type of row data.

    Parameters

    • OptionalinitialValue: Partial<IQuery<FilterData, RowData>> = DEFAULT_QUERY

      The initial value for the query.

    • Optionaloptions: Partial<IParams<FilterData, RowData>> = {}

      The options for the hook.

    Returns {
        getChipData: (() => Exclude<Partial<Record<keyof RowData, boolean>>, undefined>);
        getFilterData: (() => Exclude<Partial<FilterData>, undefined>);
        getLimit: (() => number);
        getPage: (() => number);
        getSearch: (() => string);
        getSortModel: (() => ListHandlerSortModel<RowData>);
        listProps: {
            chipData: undefined | Partial<Record<keyof RowData, boolean>>;
            fallback: undefined | ((e: Error) => void);
            filterData: undefined | Partial<FilterData>;
            limit: undefined | number;
            onChipsChange: ((data: Partial<Record<keyof RowData, boolean>>) => void);
            onFilterChange: ((data: FilterData) => void);
            onLimitChange: ((limit: number) => void);
            onPageChange: ((page: number) => void);
            onSearchChange: ((search: string) => void);
            onSortModelChange: ((sort: ListHandlerSortModel<RowData>) => void);
            page: undefined | number;
            search: undefined | string;
            sortModel: undefined | ListHandlerSortModel<RowData>;
        };
        setChipData: ((data: Partial<Record<keyof RowData, boolean>>) => void);
        setFilterData: ((data: FilterData) => void);
        setLimit: ((limit: number) => void);
        setPage: ((page: number) => void);
        setSearch: ((search: string) => void);
        setSortModel: ((sort: ListHandlerSortModel<RowData>) => void);
    }

    An object containing the pagination props and methods.

    • getChipData: (() => Exclude<Partial<Record<keyof RowData, boolean>>, undefined>)
        • (): Exclude<Partial<Record<keyof RowData, boolean>>, undefined>

        • Returns Exclude<Partial<Record<keyof RowData, boolean>>, undefined>

    • getFilterData: (() => Exclude<Partial<FilterData>, undefined>)
    • getLimit: (() => number)
        • (): number

        • Returns number

    • getPage: (() => number)
        • (): number

        • Returns number

    • getSearch: (() => string)
        • (): string

        • Returns string

    • getSortModel: (() => ListHandlerSortModel<RowData>)
        • (): ListHandlerSortModel<RowData>

        • Returns ListHandlerSortModel<RowData>

    • listProps: {
          chipData: undefined | Partial<Record<keyof RowData, boolean>>;
          fallback: undefined | ((e: Error) => void);
          filterData: undefined | Partial<FilterData>;
          limit: undefined | number;
          onChipsChange: ((data: Partial<Record<keyof RowData, boolean>>) => void);
          onFilterChange: ((data: FilterData) => void);
          onLimitChange: ((limit: number) => void);
          onPageChange: ((page: number) => void);
          onSearchChange: ((search: string) => void);
          onSortModelChange: ((sort: ListHandlerSortModel<RowData>) => void);
          page: undefined | number;
          search: undefined | string;
          sortModel: undefined | ListHandlerSortModel<RowData>;
      }
      • chipData: undefined | Partial<Record<keyof RowData, boolean>>
      • fallback: undefined | ((e: Error) => void)
      • filterData: undefined | Partial<FilterData>
      • limit: undefined | number
      • onChipsChange: ((data: Partial<Record<keyof RowData, boolean>>) => void)
          • (data): void

          • Parameters

            • data: Partial<Record<keyof RowData, boolean>>

            Returns void

      • onFilterChange: ((data: FilterData) => void)
          • (data): void

          • Parameters

            Returns void

      • onLimitChange: ((limit: number) => void)
          • (limit): void

          • Parameters

            • limit: number

            Returns void

      • onPageChange: ((page: number) => void)
          • (page): void

          • Parameters

            • page: number

            Returns void

      • onSearchChange: ((search: string) => void)
          • (search): void

          • Parameters

            • search: string

            Returns void

      • onSortModelChange: ((sort: ListHandlerSortModel<RowData>) => void)
          • (sort): void

          • Parameters

            • sort: ListHandlerSortModel<RowData>

            Returns void

      • page: undefined | number
      • search: undefined | string
      • sortModel: undefined | ListHandlerSortModel<RowData>
    • setChipData: ((data: Partial<Record<keyof RowData, boolean>>) => void)
        • (data): void

        • Parameters

          • data: Partial<Record<keyof RowData, boolean>>

          Returns void

    • setFilterData: ((data: FilterData) => void)
        • (data): void

        • Parameters

          Returns void

    • setLimit: ((limit: number) => void)
        • (limit): void

        • Parameters

          • limit: number

          Returns void

    • setPage: ((page: number) => void)
        • (page): void

        • Parameters

          • page: number

          Returns void

    • setSearch: ((search: string) => void)
        • (search): void

        • Parameters

          • search: string

          Returns void

    • setSortModel: ((sort: ListHandlerSortModel<RowData>) => void)
        • (sort): void

        • Parameters

          • sort: ListHandlerSortModel<RowData>

          Returns void

Settings

Member Visibility