<nav><ul><li><a href="/">TinyBase</a></li><li><a href="/api/">API</a></li><li><a href="/api/ui-react/"><code>ui-react</code></a></li><li><a href="/api/ui-react/functions/">Functions</a></li></ul></nav><section class="s1" id="/api/ui-react/functions/" data-id="u/F23"><h1>Functions</h1><p>These are the functions within the <a href="/api/ui-react/"><code>ui-react</code></a> module.</p><section class="s2" id="/api/ui-react/functions/checkpoints-hooks/" data-id="u/F23/C52"><h2><a href="/api/ui-react/functions/checkpoints-hooks/">Checkpoints hooks</a></h2><p>This is the collection of checkpoints hooks within the <a href="/api/ui-react/"><code>ui-react</code></a> module. There are 14 checkpoints hooks in total.</p><ul><li><a href="/api/ui-react/functions/checkpoints-hooks/usecheckpoint/"><code>useCheckpoint</code></a></li><li><a href="/api/ui-react/functions/checkpoints-hooks/usecheckpointids/"><code>useCheckpointIds</code></a></li><li><a href="/api/ui-react/functions/checkpoints-hooks/usecheckpointidslistener/"><code>useCheckpointIdsListener</code></a></li><li><a href="/api/ui-react/functions/checkpoints-hooks/usecheckpointlistener/"><code>useCheckpointListener</code></a></li><li><a href="/api/ui-react/functions/checkpoints-hooks/usecheckpoints/"><code>useCheckpoints</code></a></li><li><a href="/api/ui-react/functions/checkpoints-hooks/usecheckpointsids/"><code>useCheckpointsIds</code></a></li><li><a href="/api/ui-react/functions/checkpoints-hooks/usecheckpointsorcheckpointsbyid/"><code>useCheckpointsOrCheckpointsById</code></a></li><li><a href="/api/ui-react/functions/checkpoints-hooks/usecreatecheckpoints/"><code>useCreateCheckpoints</code></a></li><li><a href="/api/ui-react/functions/checkpoints-hooks/usegobackwardcallback/"><code>useGoBackwardCallback</code></a></li><li><a href="/api/ui-react/functions/checkpoints-hooks/usegoforwardcallback/"><code>useGoForwardCallback</code></a></li><li><a href="/api/ui-react/functions/checkpoints-hooks/usegotocallback/"><code>useGoToCallback</code></a></li><li><a href="/api/ui-react/functions/checkpoints-hooks/useredoinformation/"><code>useRedoInformation</code></a></li><li><a href="/api/ui-react/functions/checkpoints-hooks/usesetcheckpointcallback/"><code>useSetCheckpointCallback</code></a></li><li><a href="/api/ui-react/functions/checkpoints-hooks/useundoinformation/"><code>useUndoInformation</code></a></li></ul></section><section class="s2" id="/api/ui-react/functions/indexes-hooks/" data-id="u/F23/I34"><h2><a href="/api/ui-react/functions/indexes-hooks/">Indexes hooks</a></h2><p>This is the collection of indexes hooks within the <a href="/api/ui-react/"><code>ui-react</code></a> module. There are 9 indexes hooks in total.</p><ul><li><a href="/api/ui-react/functions/indexes-hooks/useslicerowids/"><code>useSliceRowIds</code></a></li><li><a href="/api/ui-react/functions/indexes-hooks/useslicerowidslistener/"><code>useSliceRowIdsListener</code></a></li><li><a href="/api/ui-react/functions/indexes-hooks/usecreateindexes/"><code>useCreateIndexes</code></a></li><li><a href="/api/ui-react/functions/indexes-hooks/useindexids/"><code>useIndexIds</code></a></li><li><a href="/api/ui-react/functions/indexes-hooks/useindexes/"><code>useIndexes</code></a></li><li><a href="/api/ui-react/functions/indexes-hooks/useindexesids/"><code>useIndexesIds</code></a></li><li><a href="/api/ui-react/functions/indexes-hooks/useindexesorindexesbyid/"><code>useIndexesOrIndexesById</code></a></li><li><a href="/api/ui-react/functions/indexes-hooks/usesliceids/"><code>useSliceIds</code></a></li><li><a href="/api/ui-react/functions/indexes-hooks/usesliceidslistener/"><code>useSliceIdsListener</code></a></li></ul></section><section class="s2" id="/api/ui-react/functions/metrics-hooks/" data-id="u/F23/M29"><h2><a href="/api/ui-react/functions/metrics-hooks/">Metrics hooks</a></h2><p>This is the collection of metrics hooks within the <a href="/api/ui-react/"><code>ui-react</code></a> module. There are 7 metrics hooks in total.</p><ul><li><a href="/api/ui-react/functions/metrics-hooks/usecreatemetrics/"><code>useCreateMetrics</code></a></li><li><a href="/api/ui-react/functions/metrics-hooks/usemetric/"><code>useMetric</code></a></li><li><a href="/api/ui-react/functions/metrics-hooks/usemetricids/"><code>useMetricIds</code></a></li><li><a href="/api/ui-react/functions/metrics-hooks/usemetriclistener/"><code>useMetricListener</code></a></li><li><a href="/api/ui-react/functions/metrics-hooks/usemetrics/"><code>useMetrics</code></a></li><li><a href="/api/ui-react/functions/metrics-hooks/usemetricsids/"><code>useMetricsIds</code></a></li><li><a href="/api/ui-react/functions/metrics-hooks/usemetricsormetricsbyid/"><code>useMetricsOrMetricsById</code></a></li></ul></section><section class="s2" id="/api/ui-react/functions/persister-hooks/" data-id="u/F23/P5"><h2><a href="/api/ui-react/functions/persister-hooks/">Persister hooks</a></h2><p>This is the collection of persister hooks within the <a href="/api/ui-react/"><code>ui-react</code></a> module. There is only one function, <a href="/api/ui-react/functions/persister-hooks/usecreatepersister/"><code>useCreatePersister</code></a>.</p><ul><li><a href="/api/ui-react/functions/persister-hooks/usecreatepersister/"><code>useCreatePersister</code></a></li></ul></section><section class="s2" id="/api/ui-react/functions/queries-hooks/" data-id="u/F23/Q3"><h2><a href="/api/ui-react/functions/queries-hooks/">Queries hooks</a></h2><p>This is the collection of queries hooks within the <a href="/api/ui-react/"><code>ui-react</code></a> module. There are 21 queries hooks in total.</p><ul><li><a href="/api/ui-react/functions/queries-hooks/useresulttable/"><code>useResultTable</code></a></li><li><a href="/api/ui-react/functions/queries-hooks/useresulttablecellids/"><code>useResultTableCellIds</code></a></li><li><a href="/api/ui-react/functions/queries-hooks/useresulttablecellidslistener/"><code>useResultTableCellIdsListener</code></a></li><li><a href="/api/ui-react/functions/queries-hooks/useresulttablelistener/"><code>useResultTableListener</code></a></li><li><a href="/api/ui-react/functions/queries-hooks/useresultrowids/"><code>useResultRowIds</code></a></li><li><a href="/api/ui-react/functions/queries-hooks/useresultrowidslistener/"><code>useResultRowIdsListener</code></a></li><li><a href="/api/ui-react/functions/queries-hooks/useresultsortedrowids/"><code>useResultSortedRowIds</code></a></li><li><a href="/api/ui-react/functions/queries-hooks/useresultsortedrowidslistener/"><code>useResultSortedRowIdsListener</code></a></li><li><a href="/api/ui-react/functions/queries-hooks/useresultrow/"><code>useResultRow</code></a></li><li><a href="/api/ui-react/functions/queries-hooks/useresultrowcount/"><code>useResultRowCount</code></a></li><li><a href="/api/ui-react/functions/queries-hooks/useresultrowcountlistener/"><code>useResultRowCountListener</code></a></li><li><a href="/api/ui-react/functions/queries-hooks/useresultrowlistener/"><code>useResultRowListener</code></a></li><li><a href="/api/ui-react/functions/queries-hooks/useresultcellids/"><code>useResultCellIds</code></a></li><li><a href="/api/ui-react/functions/queries-hooks/useresultcellidslistener/"><code>useResultCellIdsListener</code></a></li><li><a href="/api/ui-react/functions/queries-hooks/useresultcell/"><code>useResultCell</code></a></li><li><a href="/api/ui-react/functions/queries-hooks/useresultcelllistener/"><code>useResultCellListener</code></a></li><li><a href="/api/ui-react/functions/queries-hooks/usecreatequeries/"><code>useCreateQueries</code></a></li><li><a href="/api/ui-react/functions/queries-hooks/usequeries/"><code>useQueries</code></a></li><li><a href="/api/ui-react/functions/queries-hooks/usequeriesids/"><code>useQueriesIds</code></a></li><li><a href="/api/ui-react/functions/queries-hooks/usequeriesorqueriesbyid/"><code>useQueriesOrQueriesById</code></a></li><li><a href="/api/ui-react/functions/queries-hooks/usequeryids/"><code>useQueryIds</code></a></li></ul></section><section class="s2" id="/api/ui-react/functions/relationships-hooks/" data-id="u/F23/R8"><h2><a href="/api/ui-react/functions/relationships-hooks/">Relationships hooks</a></h2><p>This is the collection of relationships hooks within the <a href="/api/ui-react/"><code>ui-react</code></a> module. There are 11 relationships hooks in total.</p><ul><li><a href="/api/ui-react/functions/relationships-hooks/uselinkedrowids/"><code>useLinkedRowIds</code></a></li><li><a href="/api/ui-react/functions/relationships-hooks/uselinkedrowidslistener/"><code>useLinkedRowIdsListener</code></a></li><li><a href="/api/ui-react/functions/relationships-hooks/uselocalrowids/"><code>useLocalRowIds</code></a></li><li><a href="/api/ui-react/functions/relationships-hooks/uselocalrowidslistener/"><code>useLocalRowIdsListener</code></a></li><li><a href="/api/ui-react/functions/relationships-hooks/useremoterowid/"><code>useRemoteRowId</code></a></li><li><a href="/api/ui-react/functions/relationships-hooks/useremoterowidlistener/"><code>useRemoteRowIdListener</code></a></li><li><a href="/api/ui-react/functions/relationships-hooks/usecreaterelationships/"><code>useCreateRelationships</code></a></li><li><a href="/api/ui-react/functions/relationships-hooks/userelationshipids/"><code>useRelationshipIds</code></a></li><li><a href="/api/ui-react/functions/relationships-hooks/userelationships/"><code>useRelationships</code></a></li><li><a href="/api/ui-react/functions/relationships-hooks/userelationshipsids/"><code>useRelationshipsIds</code></a></li><li><a href="/api/ui-react/functions/relationships-hooks/userelationshipsorrelationshipsbyid/"><code>useRelationshipsOrRelationshipsById</code></a></li></ul></section><section class="s2" id="/api/ui-react/functions/store-hooks/" data-id="u/F23/S27"><h2><a href="/api/ui-react/functions/store-hooks/">Store hooks</a></h2><p>This is the collection of store hooks within the <a href="/api/ui-react/"><code>ui-react</code></a> module. There are 63 store hooks in total.</p><ul><li><a href="/api/ui-react/functions/store-hooks/usecreatestore/"><code>useCreateStore</code></a></li><li><a href="/api/ui-react/functions/store-hooks/useprovidestore/"><code>useProvideStore</code></a></li><li><a href="/api/ui-react/functions/store-hooks/usestore/"><code>useStore</code></a></li><li><a href="/api/ui-react/functions/store-hooks/usestoreids/"><code>useStoreIds</code></a></li><li><a href="/api/ui-react/functions/store-hooks/usestoreorstorebyid/"><code>useStoreOrStoreById</code></a></li><li><a href="/api/ui-react/functions/store-hooks/usedeltablescallback/"><code>useDelTablesCallback</code></a></li><li><a href="/api/ui-react/functions/store-hooks/usehastables/"><code>useHasTables</code></a></li><li><a href="/api/ui-react/functions/store-hooks/usehastableslistener/"><code>useHasTablesListener</code></a></li><li><a href="/api/ui-react/functions/store-hooks/usesettablescallback/"><code>useSetTablesCallback</code></a></li><li><a href="/api/ui-react/functions/store-hooks/usetables/"><code>useTables</code></a></li><li><a href="/api/ui-react/functions/store-hooks/usetableslistener/"><code>useTablesListener</code></a></li><li><a href="/api/ui-react/functions/store-hooks/usetableids/"><code>useTableIds</code></a></li><li><a href="/api/ui-react/functions/store-hooks/usetableidslistener/"><code>useTableIdsListener</code></a></li><li><a href="/api/ui-react/functions/store-hooks/usedeltablecallback/"><code>useDelTableCallback</code></a></li><li><a href="/api/ui-react/functions/store-hooks/usehastable/"><code>useHasTable</code></a></li><li><a href="/api/ui-react/functions/store-hooks/usehastablecell/"><code>useHasTableCell</code></a></li><li><a href="/api/ui-react/functions/store-hooks/usehastablecelllistener/"><code>useHasTableCellListener</code></a></li><li><a href="/api/ui-react/functions/store-hooks/usehastablelistener/"><code>useHasTableListener</code></a></li><li><a href="/api/ui-react/functions/store-hooks/usesettablecallback/"><code>useSetTableCallback</code></a></li><li><a href="/api/ui-react/functions/store-hooks/usetable/"><code>useTable</code></a></li><li><a href="/api/ui-react/functions/store-hooks/usetablecellids/"><code>useTableCellIds</code></a></li><li><a href="/api/ui-react/functions/store-hooks/usetablecellidslistener/"><code>useTableCellIdsListener</code></a></li><li><a href="/api/ui-react/functions/store-hooks/usetablelistener/"><code>useTableListener</code></a></li><li><a href="/api/ui-react/functions/store-hooks/userowids/"><code>useRowIds</code></a></li><li><a href="/api/ui-react/functions/store-hooks/userowidslistener/"><code>useRowIdsListener</code></a></li><li><a href="/api/ui-react/functions/store-hooks/usesortedrowids/"><code>useSortedRowIds</code></a></li><li><a href="/api/ui-react/functions/store-hooks/usesortedrowidslistener/"><code>useSortedRowIdsListener</code></a></li><li><a href="/api/ui-react/functions/store-hooks/useaddrowcallback/"><code>useAddRowCallback</code></a></li><li><a href="/api/ui-react/functions/store-hooks/usedelrowcallback/"><code>useDelRowCallback</code></a></li><li><a href="/api/ui-react/functions/store-hooks/usehasrow/"><code>useHasRow</code></a></li><li><a href="/api/ui-react/functions/store-hooks/usehasrowlistener/"><code>useHasRowListener</code></a></li><li><a href="/api/ui-react/functions/store-hooks/userow/"><code>useRow</code></a></li><li><a href="/api/ui-react/functions/store-hooks/userowcount/"><code>useRowCount</code></a></li><li><a href="/api/ui-react/functions/store-hooks/userowcountlistener/"><code>useRowCountListener</code></a></li><li><a href="/api/ui-react/functions/store-hooks/userowlistener/"><code>useRowListener</code></a></li><li><a href="/api/ui-react/functions/store-hooks/usesetpartialrowcallback/"><code>useSetPartialRowCallback</code></a></li><li><a href="/api/ui-react/functions/store-hooks/usesetrowcallback/"><code>useSetRowCallback</code></a></li><li><a href="/api/ui-react/functions/store-hooks/usecellids/"><code>useCellIds</code></a></li><li><a href="/api/ui-react/functions/store-hooks/usecellidslistener/"><code>useCellIdsListener</code></a></li><li><a href="/api/ui-react/functions/store-hooks/usecell/"><code>useCell</code></a></li><li><a href="/api/ui-react/functions/store-hooks/usecelllistener/"><code>useCellListener</code></a></li><li><a href="/api/ui-react/functions/store-hooks/usedelcellcallback/"><code>useDelCellCallback</code></a></li><li><a href="/api/ui-react/functions/store-hooks/usehascell/"><code>useHasCell</code></a></li><li><a href="/api/ui-react/functions/store-hooks/usehascelllistener/"><code>useHasCellListener</code></a></li><li><a href="/api/ui-react/functions/store-hooks/usesetcellcallback/"><code>useSetCellCallback</code></a></li><li><a href="/api/ui-react/functions/store-hooks/usedelvaluescallback/"><code>useDelValuesCallback</code></a></li><li><a href="/api/ui-react/functions/store-hooks/usehasvalues/"><code>useHasValues</code></a></li><li><a href="/api/ui-react/functions/store-hooks/usehasvalueslistener/"><code>useHasValuesListener</code></a></li><li><a href="/api/ui-react/functions/store-hooks/usesetpartialvaluescallback/"><code>useSetPartialValuesCallback</code></a></li><li><a href="/api/ui-react/functions/store-hooks/usesetvaluescallback/"><code>useSetValuesCallback</code></a></li><li><a href="/api/ui-react/functions/store-hooks/usevalues/"><code>useValues</code></a></li><li><a href="/api/ui-react/functions/store-hooks/usevalueslistener/"><code>useValuesListener</code></a></li><li><a href="/api/ui-react/functions/store-hooks/usedelvaluecallback/"><code>useDelValueCallback</code></a></li><li><a href="/api/ui-react/functions/store-hooks/usehasvalue/"><code>useHasValue</code></a></li><li><a href="/api/ui-react/functions/store-hooks/usehasvaluelistener/"><code>useHasValueListener</code></a></li><li><a href="/api/ui-react/functions/store-hooks/usesetvaluecallback/"><code>useSetValueCallback</code></a></li><li><a href="/api/ui-react/functions/store-hooks/usevalue/"><code>useValue</code></a></li><li><a href="/api/ui-react/functions/store-hooks/usevalueids/"><code>useValueIds</code></a></li><li><a href="/api/ui-react/functions/store-hooks/usevalueidslistener/"><code>useValueIdsListener</code></a></li><li><a href="/api/ui-react/functions/store-hooks/usevaluelistener/"><code>useValueListener</code></a></li><li><a href="/api/ui-react/functions/store-hooks/usedidfinishtransactionlistener/"><code>useDidFinishTransactionListener</code></a></li><li><a href="/api/ui-react/functions/store-hooks/usestarttransactionlistener/"><code>useStartTransactionListener</code></a></li><li><a href="/api/ui-react/functions/store-hooks/usewillfinishtransactionlistener/"><code>useWillFinishTransactionListener</code></a></li></ul></section><section class="s2" id="/api/ui-react/functions/checkpoints-components/" data-id="u/F23/C53"><h2><a href="/api/ui-react/functions/checkpoints-components/">Checkpoints components</a></h2><p>This is the collection of checkpoints components within the <a href="/api/ui-react/"><code>ui-react</code></a> module. There are 4 checkpoints components in total.</p><ul><li><a href="/api/ui-react/functions/checkpoints-components/backwardcheckpointsview/"><code>BackwardCheckpointsView</code></a></li><li><a href="/api/ui-react/functions/checkpoints-components/checkpointview/"><code>CheckpointView</code></a></li><li><a href="/api/ui-react/functions/checkpoints-components/currentcheckpointview/"><code>CurrentCheckpointView</code></a></li><li><a href="/api/ui-react/functions/checkpoints-components/forwardcheckpointsview/"><code>ForwardCheckpointsView</code></a></li></ul></section><section class="s2" id="/api/ui-react/functions/context-components/" data-id="u/F23/C54"><h2><a href="/api/ui-react/functions/context-components/">Context components</a></h2><p>This is the collection of context components within the <a href="/api/ui-react/"><code>ui-react</code></a> module. There is only one function, <a href="/api/ui-react/functions/context-components/provider/"><code>Provider</code></a>.</p><ul><li><a href="/api/ui-react/functions/context-components/provider/"><code>Provider</code></a></li></ul></section><section class="s2" id="/api/ui-react/functions/indexes-components/" data-id="u/F23/I35"><h2><a href="/api/ui-react/functions/indexes-components/">Indexes components</a></h2><p>This is the collection of indexes components within the <a href="/api/ui-react/"><code>ui-react</code></a> module. There are only two indexes components, <a href="/api/ui-react/functions/indexes-components/indexview/"><code>IndexView</code></a> and <a href="/api/ui-react/functions/indexes-components/sliceview/"><code>SliceView</code></a>.</p><ul><li><a href="/api/ui-react/functions/indexes-components/indexview/"><code>IndexView</code></a></li><li><a href="/api/ui-react/functions/indexes-components/sliceview/"><code>SliceView</code></a></li></ul></section><section class="s2" id="/api/ui-react/functions/metrics-components/" data-id="u/F23/M30"><h2><a href="/api/ui-react/functions/metrics-components/">Metrics components</a></h2><p>This is the collection of metrics components within the <a href="/api/ui-react/"><code>ui-react</code></a> module. There is only one function, <a href="/api/ui-react/functions/metrics-components/metricview/"><code>MetricView</code></a>.</p><ul><li><a href="/api/ui-react/functions/metrics-components/metricview/"><code>MetricView</code></a></li></ul></section><section class="s2" id="/api/ui-react/functions/queries-components/" data-id="u/F23/Q4"><h2><a href="/api/ui-react/functions/queries-components/">Queries components</a></h2><p>This is the collection of queries components within the <a href="/api/ui-react/"><code>ui-react</code></a> module. There are 4 queries components in total.</p><ul><li><a href="/api/ui-react/functions/queries-components/resultsortedtableview/"><code>ResultSortedTableView</code></a></li><li><a href="/api/ui-react/functions/queries-components/resulttableview/"><code>ResultTableView</code></a></li><li><a href="/api/ui-react/functions/queries-components/resultrowview/"><code>ResultRowView</code></a></li><li><a href="/api/ui-react/functions/queries-components/resultcellview/"><code>ResultCellView</code></a></li></ul></section><section class="s2" id="/api/ui-react/functions/relationships-components/" data-id="u/F23/R9"><h2><a href="/api/ui-react/functions/relationships-components/">Relationships components</a></h2><p>This is the collection of relationships components within the <a href="/api/ui-react/"><code>ui-react</code></a> module. There are only three relationships components, <a href="/api/ui-react/functions/relationships-components/linkedrowsview/"><code>LinkedRowsView</code></a>, <a href="/api/ui-react/functions/relationships-components/localrowsview/"><code>LocalRowsView</code></a>, and <a href="/api/ui-react/functions/relationships-components/remoterowview/"><code>RemoteRowView</code></a>.</p><ul><li><a href="/api/ui-react/functions/relationships-components/linkedrowsview/"><code>LinkedRowsView</code></a></li><li><a href="/api/ui-react/functions/relationships-components/localrowsview/"><code>LocalRowsView</code></a></li><li><a href="/api/ui-react/functions/relationships-components/remoterowview/"><code>RemoteRowView</code></a></li></ul></section><section class="s2" id="/api/ui-react/functions/store-components/" data-id="u/F23/S28"><h2><a href="/api/ui-react/functions/store-components/">Store components</a></h2><p>This is the collection of store components within the <a href="/api/ui-react/"><code>ui-react</code></a> module. There are 7 store components in total.</p><ul><li><a href="/api/ui-react/functions/store-components/tablesview/"><code>TablesView</code></a></li><li><a href="/api/ui-react/functions/store-components/tableview/"><code>TableView</code></a></li><li><a href="/api/ui-react/functions/store-components/sortedtableview/"><code>SortedTableView</code></a></li><li><a href="/api/ui-react/functions/store-components/rowview/"><code>RowView</code></a></li><li><a href="/api/ui-react/functions/store-components/cellview/"><code>CellView</code></a></li><li><a href="/api/ui-react/functions/store-components/valuesview/"><code>ValuesView</code></a></li><li><a href="/api/ui-react/functions/store-components/valueview/"><code>ValueView</code></a></li></ul></section></section>