This is the collection of queries hooks within the ui-react
module. There are 14 queries hooks in total.
useResultTable
The useResultTable
hook returns an object containing the entire data of the result Table
of the given query, and registers a listener so that any changes to that result will cause a re-render.
useResultTableListener
The useResultTableListener
hook registers a listener function with a Queries
object that will be called whenever data in a result Table
changes.
useResultRowIds
The useResultRowIds
hook returns the Ids
of every Row
in the result Table
of the given query, and registers a listener so that any changes to those Ids
will cause a re-render.
useResultRowIdsListener
The useResultRowIdsListener
hook registers a listener function with a Queries
object that will be called whenever the Row
Ids
in a result Table
change.
useResultSortedRowIds
The useResultSortedRowIds
hook returns the sorted (and optionally, paginated) Ids
of every Row
in the result Table
of the given query, and registers a listener so that any changes to those Ids
will cause a re-render.
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 result Table
change.
useResultRow
The useResultRow
hook returns an object containing the entire data of a single Row
in the result Table
of the given query, and registers a listener so that any changes to that Row
will cause a re-render.
useResultRowListener
The useResultRowListener
hook registers a listener function with a Queries
object that will be called whenever data in a result Row
changes.
useResultCellIds
The useResultCellIds
hook returns the Ids
of every Cell
in a given Row
in the result Table
of the given query, and registers a listener so that any changes to those Ids
will cause a re-render.
useResultCellIdsListener
The useResultCellIdsListener
hook registers a listener function with a Queries
object that will be called whenever the Cell
Ids
in a result Row
change.
useResultCell
The useResultCell
hook returns the value of a single Cell
in a given Row
in the result Table
of the given query, and registers a listener so that any changes to that value will cause a re-render.
useResultCellListener
The useResultCellListener
hook registers a listener function with a Queries
object that will be called whenever data in a Cell
changes.
useCreateQueries
The useCreateQueries
hook is used to create a Queries
object within a React application with convenient memoization.
useQueries
The useQueries
hook is used to get a reference to a Queries
object from within a Provider
component context.