9a046ea285
* Update collections.md * Add changefile(s) from automation for the following project(s): woocommerce-blocks --------- Co-authored-by: github-actions <github-actions@github.com> |
||
|---|---|---|
| .. | ||
| README.md | ||
| cart.md | ||
| checkout.md | ||
| collections.md | ||
| payment.md | ||
| query-state.md | ||
| schema.md | ||
| store-notices.md | ||
| validation.md | ||
README.md
Data Store
This document provides an overview of the data stores registered with wp.data for use by various blocks. Store keys are exported as constants on the wc.wcBlocksData export (externally registered as @woocommerce/block-data and enqueued via handle wc-blocks-data-store). For any block using the store, it's recommended to import the store key rather than using the reference directly to ensure dependencies are extracted correctly. It is assumed readers have some familiarity with the wp.data API. You can read more about that here.
Cart Store (wc/store/cart)
The Cart Store (wc/store/cart) is responsible for handling cart-related data and operations. To access this store using a constant, you can use:
const { CART_STORE_KEY } = window.wc.wcBlocksData;
Checkout Store (wc/store/checkout)
The Checkout Store (wc/store/checkout) manages the checkout process, ensuring a seamless experience for users. To access this store using a constant, you can use:
const { CHECKOUT_STORE_KEY } = window.wc.wcBlocksData;
Collections Store (wc/store/collections)
The Collections Store (wc/store/collections) holds data indexed by namespace, model name, and query string. To access this store using a constant, you can use:
const { COLLECTIONS_STORE_KEY } = window.wc.wcBlocksData;
Payment Store (wc/store/payment)
The Payment Store (wc/store/payment) deals with all payment-related data and transactions. To access this store using a constant, you can use:
const { PAYMENT_STORE_KEY } = window.wc.wcBlocksData;
Query-State Store (wc/store/query-state)
The Query-State Store (wc/store/query-state) holds arbitrary values indexed by context and key. It's often used for tracking the state of query objects for a given context. To access this store using a constant, you can use:
const { QUERY_STATE_STORE_KEY } = window.wc.wcBlocksData;
Schema Store (wc/store/schema)
The Schema Store (wc/store/schema) is primarily used for accessing routes and has more of an internal usage. To access this store using a constant, you can use:
const { SCHEMA_STORE_KEY } = window.wc.wcBlocksData;
Store Notices Store (wc/store/store-notices)
The Store Notices Store (wc/store/store-notices) is dedicated to handling various store notices and alerts. To access this store using a constant, you can use:
const { STORE_NOTICES_STORE_KEY } = window.wc.wcBlocksData;
Validation Store (wc/store/validation)
The Validation Store (wc/store/validation) holds data relating to validation errors, it is primarily used in the Cart and Checkout flows to ensure the Checkout doesn't continue while invalid data is present. To access this store using a constant, you can use:
const { VALIDATION_STORE_KEY } = window.wc.wcBlocksData;
We're hiring! Come work with us!
🐞 Found a mistake, or have a suggestion? Leave feedback about this document here.