`getSortedRowIds`

The getSortedRowIds function returns a reactive object reflecting the sorted Row Ids in a Table, and registers a listener so that any changes will update current.

getSortedRowIds(
  tableId: MaybeGetter<string>,
  cellId?: MaybeGetter<undefined | string>,
  descending?: MaybeGetter<boolean>,
  offset?: MaybeGetter<number>,
  limit?: MaybeGetter<undefined | number>,
  storeOrStoreId?: MaybeGetter<undefined | StoreOrStoreId>,
): {current: Ids}

	Type	Description
`tableId`	`MaybeGetter<string>`	The `Id` of the `Table` (or a getter returning it).
`cellId?`	`MaybeGetter<undefined \| string>`	The `Id` of the `Cell` to sort by (or a getter returning it).
`descending?`	`MaybeGetter<boolean>`	Whether to sort descending (or a getter returning it).
`offset?`	`MaybeGetter<number>`	The starting `Row` offset (or a getter returning it).
`limit?`	`MaybeGetter<undefined \| number>`	The maximum number of Rows to return (or a getter returning it).
`storeOrStoreId?`	`MaybeGetter<undefined \| StoreOrStoreId>`	The `Store` to use (plain value or getter), or its `Id`.
returns	`{current: Ids}`	A reactive object with a `current` `Ids` property.

Example

This example passes a TinyBase object into a Svelte component and reads the reactive object's current property.

App.svelte

<svelte:options runes={true} />

<script>
  import {getSortedRowIds} from 'tinybase/ui-svelte';

  let {store} = $props();

  const result = getSortedRowIds('pets', 'sold', false, 0, undefined, store);
</script>

{JSON.stringify(result.current)}

import {flushSync, mount} from 'svelte';
import {createStore} from 'tinybase';
import App from './App.svelte';

const store = createStore()
  .setTables({
    pets: {
      fido: {species: 'dog', color: 'brown', sold: false, next: 'felix'},
      felix: {species: 'cat', color: 'black', sold: true},
    },
    species: {dog: {price: 5}, cat: {price: 4}},
  })
  .setValues({open: true, employees: 3});
const app = document.body.appendChild(document.createElement('div'));
flushSync(() => mount(App, {target: app, props: {store}}));
console.log(app.textContent);
// -> '["fido","felix"]'

Since

v8.1.0