TinyBase logoTinyBase

useResultSortedRowIdsListener

The useResultSortedRowIdsListener hook registers a listener function with a Queries object that will be called whenever the sorted (and optionally, paginated) Row Ids in a ResultTable change.

useResultSortedRowIdsListener(
  queryId: Id,
  cellId: any,
  descending: boolean,
  offset: number,
  limit: undefined | number,
  listener: ResultSortedRowIdsListener,
  listenerDeps?: DependencyList,
  queriesOrQueriesId?: any,
): void
TypeDescription
queryIdId

The Id of the query to listen to.

cellIdany

The Id of the Cell whose values are used for the sorting, or undefined to by sort the Row Id itself.

descendingboolean

Whether the sorting should be in descending order.

offsetnumber

The number of Row Ids to skip for pagination purposes, if any.

limitundefined | number

The maximum number of Row Ids to return, or undefined for all.

listenerResultSortedRowIdsListener

The function that will be called whenever the Row Ids in the matching ResultTable change.

listenerDeps?DependencyList

An optional array of dependencies for the listener function, which, if any change, result in the re-registration of the listener. This parameter defaults to an empty array.

queriesOrQueriesId?any

The Queries object to register the listener with: omit for the default context Queries object, provide an Id for a named context Queries object, or provide an explicit reference.

returnsvoid

This has no return value.

This hook is useful for situations where a component needs to register its own specific listener to do more than simply tracking the value (which is more easily done with the useResultSortedRowIds hook).

Unlike the addResultSortedRowIdsListener method, which returns a listener Id and requires you to remove it manually, the useResultSortedRowIdsListener hook manages this lifecycle for you: when the listener changes (per its listenerDeps dependencies) or the component unmounts, the listener on the underlying Queries object will be deleted.

Example

This example uses the useResultSortedRowIdsListener hook to create a listener that is scoped to a single component. When the component is unmounted, the listener is removed from the Queries object.

const App = ({queries}) => (
  <Provider queries={queries}>
    <Pane />
  </Provider>
);
const Pane = () => {
  useResultSortedRowIdsListener(
    'petColors',
    'color',
    false,
    0,
    undefined,
    () => console.log('Sorted result Row Ids changed'),
  );
  return <span>App</span>;
};

const store = createStore().setTable('pets', {
  fido: {species: 'dog', color: 'brown'},
  felix: {species: 'cat', color: 'black'},
  cujo: {species: 'dog', color: 'black'},
});
const queries = createQueries(store).setQueryDefinition(
  'petColors',
  'pets',
  ({select}) => select('color'),
);
const app = document.createElement('div');
const root = ReactDOMClient.createRoot(app);
root.render(<App queries={queries} />);
console.log(queries.getListenerStats().sortedRowIds);
// -> 1

store.setRow('pets', 'cujo', {color: 'tan'});
// -> 'Sorted result Row Ids changed'

root.unmount();
console.log(queries.getListenerStats().sortedRowIds);
// -> 0

Since

v2.0.0