TinyBase logoTinyBase

Indexes hooks

This is the collection of indexes hooks within the ui-react module. There are 9 indexes hooks in total.

useSliceRowIds

The useSliceRowIds hook gets the list of Row Ids in a given Slice, and registers a listener so that any changes to that result will cause a re-render.

useSliceRowIdsListener

The useSliceRowIdsListener hook registers a listener function with the Indexes object that will be called whenever the Row Ids in a Slice change.

useCreateIndexes

The useCreateIndexes hook is used to create an Indexes object within a React application with convenient memoization.

useIndexIds

The useIndexIds hook gets an array of the Index Ids registered with an Indexes object, and registers a listener so that any changes to that result will cause a re-render.

useIndexes

The useIndexes hook is used to get a reference to an Indexes object from within a Provider component context.

useIndexesIds

The useIndexesIds hook is used to retrieve the Ids of all the named Indexes objects present in the current Provider component context.

useIndexesOrIndexesById

The useIndexesOrIndexesById hook is used to get a reference to an Indexes object from within a Provider component context, or have it passed directly to this hook.

useSliceIds

The useSliceIds hook gets the list of Slice Ids in an Index, and registers a listener so that any changes to that result will cause a re-render.

useSliceIdsListener

The useSliceIdsListener hook registers a listener function with the Indexes object that will be called whenever the Slice Ids in an Index change.