woocommerce/packages/js/notices
jonathansadowski d48a0b2d90
Add helper tool for making sure build, lint, and test are run through Turborepo (#33573)
* Add helper tool for making sure build, lint, and test are run through Turborepo

* Update node version for require-turbo
2022-06-28 13:17:05 -05:00
..
src Fix JS lint errors (#33484) 2022-06-21 16:37:34 +08:00
.eslintrc.js Removed `@woocommerce/notices` Internal Prefix (#33283) 2022-06-03 16:05:26 -07:00
.npmrc Removed `@woocommerce/notices` Internal Prefix (#33283) 2022-06-03 16:05:26 -07:00
CHANGELOG.md Removed `@woocommerce/notices` Internal Prefix (#33283) 2022-06-03 16:05:26 -07:00
README.md Removed `@woocommerce/notices` Internal Prefix (#33283) 2022-06-03 16:05:26 -07:00
changelog Add helper tool for making sure build, lint, and test are run through Turborepo (#33573) 2022-06-28 13:17:05 -05:00
package.json Add helper tool for making sure build, lint, and test are run through Turborepo (#33573) 2022-06-28 13:17:05 -05:00
project.json Removed `@woocommerce/notices` Internal Prefix (#33283) 2022-06-03 16:05:26 -07:00
tsconfig-cjs.json Removed `@woocommerce/notices` Internal Prefix (#33283) 2022-06-03 16:05:26 -07:00
tsconfig.json Removed `@woocommerce/notices` Internal Prefix (#33283) 2022-06-03 16:05: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.