react-use-table-query-params v0.0.3

useTableQueryParams

A simple React library for managing filtering and pagination through the URL

API

useTableQueryParams()

useTableQueryParams(args: UseTableQueryParamsArgs<
    QKey extends string,
    QObj extends Partial<Record<QKey, any>>,
    FObj extends Record<string, any>,
    OKey extends string,
    ODirection extends OrderDirection>
) => UseTableQueryParamsResponse<QKey, QObj, FObj, OKey, ODirection>

interface UseTableQueryParamsResponse<
    QKey extends string,
    QObj extends Partial<Record<QKey, any>>,
    FObj extends Record<string, any>,
    OKey extends string,
    ODirection extends OrderDirection,
> extends UsePaginationParamsResponse {
    filtersForRequest: QObj,
    filtersForRender: FObj,
    onSubmitFilters: (data: FObj) => void,
    clearFilters: () => void,
    changeOrder: (key: OKey) => void,
    orderBy: Optional<OKey>,
    orderDirection: Optional<ODirection>,
    offset?: number,
    limit?: number,
}

Parameter extends from parameters of usePaginationParams