useTable
The useTable primitive returns an object containing the data of a single Table in a Store, and registers a listener so that any changes to that result will cause an update.
useTable(
tableId: MaybeAccessor<string>,
storeOrStoreId?: MaybeAccessor<undefined | StoreOrStoreId>,
): Accessor<Table>| Type | Description | |
|---|---|---|
tableId | MaybeAccessor<string> | |
storeOrStoreId? | MaybeAccessor<undefined | StoreOrStoreId> | The |
| returns | Accessor<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 Store or a set of Store objects named by Id. The useTable primitive lets you indicate which Store to get data for: omit the final optional parameter for the default context Store, provide an Id for a named context Store, or provide a Store explicitly by reference.
When first rendered, this primitive will create a listener so that changes to the Table will cause an update. When the component containing this primitive is unmounted, the listener will be automatically removed.
Example
This example creates a Store, binds it to the primitive, and reads the resulting Solid Accessor.
import {createRoot} from 'solid-js';
import {createStore} from 'tinybase';
import {useTable} from 'tinybase/ui-solid';
createRoot((dispose) => {
const store = createStore().setCell('pets', 'fido', 'species', 'dog');
const table = useTable('pets', store);
console.log(JSON.stringify(table()));
// -> '{"fido":{"species":"dog"}}'
dispose();
});
Since
v8.3.0