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.
useResultTable(
queryId: string,
queriesOrQueriesId?: QueriesOrQueriesId,
): Table
Type | Description | |
---|---|---|
queryId | string | The |
queriesOrQueriesId? | QueriesOrQueriesId | The |
returns | Table | An object containing the entire data of the |
A Provider
component is used to wrap part of an application in a context, and it can contain a default Queries
object or a set of Queries
objects named by Id
. The useResultTable
hook lets you indicate which Queries
object to get data for: omit the final optional final parameter for the default context Queries
object, provide an Id
for a named context Queries
object, or provide a Queries
object explicitly by reference.
When first rendered, this hook will create a listener so that changes to the query result will cause a re-render. When the component containing this hook is unmounted, the listener will be automatically removed.
Examples
This example creates a Queries
object outside the application, which is used in the useTable
hook by reference. A change to the data in the query re-renders the component.
import {createQueries, createStore} from 'tinybase';
import React from 'react';
import {createRoot} from 'react-dom/client';
import {useResultTable} from 'tinybase/ui-react';
const store = createStore().setTable('pets', {
fido: {species: 'dog', color: 'brown'},
felix: {species: 'cat', color: 'black'},
cujo: {species: 'dog', color: 'black'},
});
const queries = createQueries(store).setQueryDefinition(
'dogColors',
'pets',
({select, where}) => {
select('color');
where('species', 'dog');
},
);
const App = () => (
<span>{JSON.stringify(useResultTable('dogColors', queries))}</span>
);
const app = document.createElement('div');
createRoot(app).render(<App />);
console.log(app.innerHTML);
// -> '<span>{"fido":{"color":"brown"},"cujo":{"color":"black"}}</span>'
store.setCell('pets', 'fido', 'color', 'walnut');
console.log(app.innerHTML);
// -> '<span>{"fido":{"color":"walnut"},"cujo":{"color":"black"}}</span>'
This example creates a Provider context into which a default Queries
object is provided. A component within it then uses the useResultTable
hook.
import {Provider, useResultTable} from 'tinybase/ui-react';
import {createQueries, createStore} from 'tinybase';
import React from 'react';
import {createRoot} from 'react-dom/client';
const App = ({queries}) => (
<Provider queries={queries}>
<Pane />
</Provider>
);
const Pane = () => (
<span>{JSON.stringify(useResultTable('dogColors'))}</span>
);
const queries = createQueries(
createStore().setTable('pets', {
fido: {species: 'dog', color: 'brown'},
felix: {species: 'cat', color: 'black'},
cujo: {species: 'dog', color: 'black'},
}),
).setQueryDefinition('dogColors', 'pets', ({select, where}) => {
select('color');
where('species', 'dog');
});
const app = document.createElement('div');
createRoot(app).render(<App queries={queries} />);
console.log(app.innerHTML);
// -> '<span>{"fido":{"color":"brown"},"cujo":{"color":"black"}}</span>'
This example creates a Provider context into which a Queries
object is provided, named by Id
. A component within it then uses the useResultTable
hook.
import {Provider, useResultTable} from 'tinybase/ui-react';
import {createQueries, createStore} from 'tinybase';
import React from 'react';
import {createRoot} from 'react-dom/client';
const App = ({queries}) => (
<Provider queriesById={{petQueries: queries}}>
<Pane />
</Provider>
);
const Pane = () => (
<span>{JSON.stringify(useResultTable('dogColors', 'petQueries'))}</span>
);
const queries = createQueries(
createStore().setTable('pets', {
fido: {species: 'dog', color: 'brown'},
felix: {species: 'cat', color: 'black'},
cujo: {species: 'dog', color: 'black'},
}),
).setQueryDefinition('dogColors', 'pets', ({select, where}) => {
select('color');
where('species', 'dog');
});
const app = document.createElement('div');
createRoot(app).render(<App queries={queries} />);
console.log(app.innerHTML);
// -> '<span>{"fido":{"color":"brown"},"cujo":{"color":"black"}}</span>'
Since
v2.0.0