TinyBase logoTinyBase

Queries hooks

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

useResultTable

The useResultTable hook returns an object containing the entire data of the ResultTable of the given query, and registers a listener so that any changes to that result will cause a re-render.

Read more

useResultTableCellIds

The useResultTableCellIds hook returns the Ids of every Cell used across the whole ResultTable of the given query, and registers a listener so that any changes to those Ids will cause a re-render.

Read more

useResultTableCellIdsListener

The useResultTableCellIdsListener hook registers a listener function with a Queries object that will be called whenever the Cell Ids that appear anywhere in a ResultTable change.

Read more

useResultTableListener

The useResultTableListener hook registers a listener function with a Queries object that will be called whenever data in a ResultTable changes.

Read more

useResultRowIds

The useResultRowIds hook returns the Ids of every Row in the ResultTable of the given query, and registers a listener so that any changes to those Ids will cause a re-render.

Read more

useResultRowIdsListener

The useResultRowIdsListener hook registers a listener function with a Queries object that will be called whenever the Row Ids in a ResultTable change.

Read more

useResultSortedRowIds

The useResultSortedRowIds hook returns the sorted (and optionally, paginated) Ids of every Row in the ResultTable of the given query, and registers a listener so that any changes to those Ids will cause a re-render.

Read more

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.

Read more

useResultRow

The useResultRow hook returns an object containing the data of a single Row in the ResultTable of the given query, and registers a listener so that any changes to that Row will cause a re-render.

Read more

useResultRowCount

The useResultRowCount hook returns the count of the Row objects in the ResultTable of the given query, and registers a listener so that any changes to that result will cause a re-render.

Read more

useResultRowCountListener

The useResultRowCountListener hook registers a listener function with a Queries object that will be called whenever the count of ResultRow objects in a ResultTable changes.

Read more

useResultRowListener

The useResultRowListener hook registers a listener function with a Queries object that will be called whenever data in a result Row changes.

Read more

useResultCellIds

The useResultCellIds hook returns the Ids of every Cell in a given Row in the ResultTable of the given query, and registers a listener so that any changes to those Ids will cause a re-render.

Read more

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.

Read more

useResultCell

The useResultCell hook returns the value of a single Cell in a given Row in the ResultTable of the given query, and registers a listener so that any changes to that value will cause a re-render.

Read more

useResultCellListener

The useResultCellListener hook registers a listener function with a Queries object that will be called whenever data in a Cell changes.

Read more

useCreateQueries

The useCreateQueries hook is used to create a Queries object within a React application with convenient memoization.

Read more

useQueries

The useQueries hook is used to get a reference to a Queries object from within a Provider component context.

Read more

useQueriesIds

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

Read more

useQueriesOrQueriesById

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

Read more

useQueryIds

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

Read more