Skip to Content
BBRICKSv0.7.4
DataHooks

useUrlSort

A list's sort in the URL. Only keys the list offers count (a stale or hand-typed key falls back). The dir sent equals the dir shown: a bare sort= reads, shows and sends as desc, never the server's own per-field default.

import { useUrlSort } from '@ergasti/bricks';

Examples

Sort in the URL

useUrlSort allows only the keys you list, writes sort and dir in one history write (here to the query string under docs), and gives you params for your request. The fallback sort is never written.

Code
import { DataTable, useUrlSort, type DataColumn } from '@ergasti/bricks';

interface Row { id: number; name: string; amount: number }

const rows: Row[] = [{ id: 1, name: 'Laila', amount: 120 }, { id: 2, name: 'Karim', amount: 340 }, { id: 3, name: 'Salma', amount: 90 }];

const columns: DataColumn<Row>[] = [
  { key: 'name', label: 'Name', sortKey: 'name', sortFirst: 'asc', render: (r) => r.name },
  { key: 'amount', label: 'Amount', sortKey: 'amount', align: 'end', render: (r) => r.amount },
];

function Sorted() {
  const { sort, params, onSort } = useUrlSort(['name', 'amount'], { namespace: 'docs', location: 'query', fallback: { key: 'amount', dir: 'desc' } });
  const active = sort ?? { key: 'amount', dir: 'desc' as const };
  const sorted = [...rows].sort((a, b) => ((a[active.key as keyof Row] > b[active.key as keyof Row] ? 1 : -1) * (active.dir === 'asc' ? 1 : -1)));
  return (
    <div>
      <DataTable label="Amounts" columns={columns} rows={sorted} rowKey={(r) => r.id} sort={active} onSort={onSort} />
      <small>Request params: <code>{JSON.stringify(params)}</code></small>
    </div>
  );
}

Signature

function useUrlSort(keys: readonly string[], options2?: UrlSortOptions): UrlSort

Parameters

options2: UrlSortOptions

Prop

Type

Returns

UrlSort

useUrlParams · DataTable · useAction · useDataLanguage · useDebouncedCallback · useDrawerResource

Source

src/data/useUrlSort.ts (line 40) on GitHub.

On this page