`useSortedRowIdsListener`

The useSortedRowIdsListener hook registers a listener function with a Store that will be called whenever sorted (and optionally, paginated) Row Ids in a Table change.

useSortedRowIdsListener(
  tableId: Id,
  cellId: any,
  descending: boolean,
  offset: number,
  limit: undefined | number,
  listener: SortedRowIdsListener,
  listenerDeps?: DependencyList,
  mutator?: boolean,
  storeOrStoreId?: any,
): void

	Type	Description
`tableId`	`Id`	The `Id` of the `Table` in the `Store`.
`cellId`	`any`	The `Id` of the `Cell` whose values are used for the sorting, or `undefined` to by sort the `Row` `Id` itself.
`descending`	`boolean`	Whether the sorting should be in descending order.
`offset`	`number`	The number of `Row` `Ids` to skip for pagination purposes, if any.
`limit`	`undefined \| number`	The maximum number of `Row` `Ids` to return, or `undefined` for all.
`listener`	`SortedRowIdsListener`	The function that will be called whenever the sorted `Row` `Ids` in the `Table` 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.
`mutator?`	`boolean`	An optional boolean that indicates that the listener mutates `Store` data.
`storeOrStoreId?`	`any`	The `Store` to register the listener with: omit for the default context `Store`, provide an `Id` for a named context `Store`, or provide an explicit reference.
returns	`void`	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 useSortedRowIds hook).

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

Example

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

const App = ({store}) => (
  <Provider store={store}>
    <Pane />
  </Provider>
);
const Pane = () => {
  useSortedRowIdsListener('pets', 'species', false, 0, undefined, () =>
    console.log('Sorted Row Ids changed'),
  );
  return <span>App</span>;
};

const store = createStore().setTables({
  pets: {
    fido: {species: 'dog'},
    felix: {species: 'cat'},
  },
});
const app = document.createElement('div');
const root = ReactDOMClient.createRoot(app);
root.render(<App store={store} />);
console.log(store.getListenerStats().sortedRowIds);
// -> 1

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

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

Since

v2.0.0