woocommerce/plugins/woocommerce-blocks/docs/internal-developers/block-client-apis/notices.md

70 lines
2.8 KiB
Markdown
Raw Normal View History

# Frontend notices <!-- omit in toc -->
## Table of contents <!-- omit in toc -->
- [Notices in WooCommerce Blocks](#notices-in-woocommerce-blocks)
- [`StoreNoticesContainer`](#storenoticescontainer)
- [Snackbar notices in WooCommerce Blocks](#snackbar-notices-in-woocommerce-blocks)
- [`SnackbarNoticesContainer`](#snackbarnoticescontainer)
## Notices in WooCommerce Blocks
WooCommerce Blocks uses the [`@wordpress/notices`](https://github.com/WordPress/gutenberg/blob/d9eb36d80e05b4e45b1ad8462c8bace4e9cf1f6f/docs/reference-guides/data/data-core-notices.md) package to display notices in the frontend. For more information on the actions and selectors available on this data store, please review [the `@wordpress/notices` documentation](https://github.com/WordPress/gutenberg/blob/d9eb36d80e05b4e45b1ad8462c8bace4e9cf1f6f/docs/reference-guides/data/data-core-notices.md)
### `StoreNoticesContainer`
To display notices of a certain context, use the `StoreNoticesContainer` and pass the context as a prop to it.
The below example will show all notices with type `default` that are in the `wc/cart` context. If no context prop is passed, then the `default` context will be used.
On the Cart Block, a `StoreNoticesContainer` is already rendered with the `wc/cart` context, and on the Checkout Block, a `StoreNoticesContainer` is already rendered with the `wc/checkout` context. To display errors from other contexts, you can use the `StoreNoticesContainer` component with context passed as a prop.
```jsx
import { StoreNoticesContainer } from '@woocommerce/blocks-checkout';
const PaymentErrors = () => {
return <StoreNoticesContainer context="wc/payment" />;
};
```
## Snackbar notices in WooCommerce Blocks
WooCommerce Blocks also shows snackbar notices, to add a snackbar notice you need to create a notice with `type:snackbar` in the options object.
```js
import { dispatch } from '@wordpress/data';
dispatch( 'core/notices' ).createNotice(
'snackbar',
'This is a snackbar notice',
{
type: 'snackbar',
actions: [
{
label: 'Dismiss',
onClick: () => {
dispatch( 'core/notices' ).removeNotice(
'snackbar-notice-id'
);
},
},
],
},
'snackbar-notice-id'
);
```
### `SnackbarNoticesContainer`
To display snackbar notices, use the `SnackbarNoticesContainer` component. This component is rendered with the Cart and Checkout blocks, so there is no need to add another. The context it displays notices for is `default`. If, for some reason you do need to show snackbar messages for a different context, you can render this component again and pass the context as a prop to the component.
```jsx
import { SnackbarNoticesContainer } from '@woocommerce/base-components/snackbar-notices-container';
const AlternativeSnackbarNotices = () => {
return (
<SnackbarNoticesContainer context="wc/alternative-snackbar-notices" />
);
};
```