33 lines
2.1 KiB
Markdown
33 lines
2.1 KiB
Markdown
# Query State Store
|
|
|
|
To utilize this store you will import the `QUERY_STATE_STORE_KEY` in any module referencing it. Assuming `@woocommerce/block-data` is registered as an external pointing to `wc.wcBlocksData` you can import the key via:
|
|
|
|
```js
|
|
import { QUERY_STATE_STORE_KEY } from '@woocommerce/block-data';
|
|
```
|
|
|
|
## Actions
|
|
|
|
The following actions are used for dispatching data to this store state.
|
|
|
|
> **Note:**: New values will always overwrite any existing entry in the store.
|
|
|
|
### `setQueryValue( context, queryKey, value )`
|
|
|
|
This will set a single query-state value for a given context.
|
|
|
|
| Argument | Type | Description |
|
|
| ---------- | ------ | ----------------------------------------------------------------------------------------------------------------------- |
|
|
| `context` | string | The context for the query state being stored (eg. might be a block name so you can keep query-state specific per block) |
|
|
| `queryKey` | string | The reference for the value being stored. |
|
|
| `value` | mixed | The actual value being stored for the query-state. |
|
|
|
|
### `setValueForQueryContext( context, value )`
|
|
|
|
This will set the query-state for a given context. Typically this is used to set/replace the entire query-state for a given context rather than the individual keys for the context via `setQueryValue`.
|
|
|
|
| Argument | Type | Description |
|
|
| --------- | ------ | ----------------------------------------------------------------------------------------------------------------------- |
|
|
| `context` | string | The context for the query state being stored (eg. might be a block name so you can keep query-state specific per block) |
|
|
| `value` | Object | An object of key/value pairs for the query state being attached to the context. |
|