452c522b95
* Fix Gutenberg links in the docs pointing to the wrong branch * Add changefile(s) from automation for the following project(s): @woocommerce/notices, @woocommerce/eslint-plugin, @woocommerce/dependency-extraction-webpack-plugin, @woocommerce/components, woocommerce-blocks, woocommerce-beta-tester, woo-ai * Fix markdown lint errors * Fix wrong link in the docs --------- Co-authored-by: github-actions <github-actions@github.com> |
||
|---|---|---|
| .. | ||
| changelog | ||
| src | ||
| .eslintrc.js | ||
| .npmrc | ||
| CHANGELOG.md | ||
| README.md | ||
| composer.json | ||
| composer.lock | ||
| package.json | ||
| tsconfig-cjs.json | ||
| tsconfig.json | ||
README.md
Notices
State management for notices.
NOTE: This has been copied from Gutenberg so that we can iterate on it faster than if we were relying on Gutenberg releasing a new version with our requirements. Once Gutenberg supports our requirements this package should be removed.
Update: Changes required have been shipped in the Gutenberg package released with WP 5.7, so this package will be removed when WP 5.9 becomes available. Please use the Gutenberg version instead.
Installation
Install the module
pnpm install @wordpress/notices
This package assumes that your code will run in an ES2015+ environment. If you're using an environment that has limited or no support for ES2015+ such as lower versions of IE then using core-js or @babel/polyfill will add support for these methods. Learn more about it in Babel docs.
Usage
When imported, the notices module registers a data store on the core/notices namespace. In WordPress, this is accessed from wp.data.dispatch( 'core/notices' ).
For more information about consuming from a data store, refer to the @wordpress/data documentation on Data Access and Manipulation.
For a full list of actions and selectors available in the core/notices namespace, refer to the Notices Data Handbook page.
