woocommerce/packages/js/notices
Chi-Hsuan Huang ba17630dca
Merge pull request #32515 from woocommerce/update/32296-wordpress-dependencies
Update @wordpress/* dependencies
2022-04-08 10:08:48 +08:00
..
src Moved WCA Packages 2022-03-18 14:25:26 -07:00
.eslintrc.js Add .eslintrc config to each packages 2022-03-29 16:08:07 +08:00
.npmrc Moved WCA Packages 2022-03-18 14:25:26 -07:00
CHANGELOG.md Update package changelogs 2022-04-07 14:34:42 +08:00
README.md Moved WCA Packages 2022-03-18 14:25:26 -07:00
package.json Merge pull request #32515 from woocommerce/update/32296-wordpress-dependencies 2022-04-08 10:08:48 +08:00
project.json Add build-watch to most js packages and remove packages watch from woocommerce-admin command 2022-03-30 11:46:12 -03:00
tsconfig-cjs.json Moved WCA Packages 2022-03-18 14:25:26 -07:00
tsconfig.json Moved WCA Packages 2022-03-18 14:25:26 -07:00

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.



Code is Poetry.