Notice Edit

Use Notices to communicate prominent messages to the user.

Notice component

Table of contents

  1. Design guidelines
  2. Development guidelines
  3. Related components

Top ↑

Design guidelines

A Notice displays a succinct message. It can also offer the user options, like viewing a published post or updating a setting, and requires a user action to be dismissed.

Use Notices to communicate things that are important but don’t necessarily require action — a user can keep using the product even if they don’t choose to act on a Notice. They are less interruptive than a Modal.

Top ↑

Usage

Notices display at the top of the screen, below any toolbars anchored to the top of the page. They’re persistent and non-modal. Since they don’t overlay the content, users can ignore or dismiss them, and choose when to interact with them.

Notices are color-coded to indicate the type of message being communicated:

  • Informational notices are blue by default.
  • If there is a parent Theme component with an accent color prop, informational notices will take on that color instead.
  • Success notices are green.
  • Warning notices are yellow**.**
  • Error notices are red.

If an icon is included in the Notice, it should be color-coded to match the Notice state.

Top ↑

Do’s and Don’ts

Do use a Notice when you want to communicate a message of medium importance.

A success Notice for updating a post


Don’t use a Notice for a message that requires immediate attention and action from the user. Use a Modal for this instead.

A Notice that requires an immediate action


Do display Notices at the top of the screen, below any toolbars.

A success Notice for publishing a post


Don’t show Notices on top of toolbars.

A success Notice on top of the editor toolbar


Do use color to indicate the type of message being communicated.

An error Notice using red


Don’t apply any colors other than those for Warnings, Success, or Errors.

An error Notice using purple

Top ↑

Development guidelines

Top ↑

Usage

To display a plain notice, pass Notice a string:

import { Notice } from `@wordpress/components`;

const MyNotice = () => (
    <Notice status="error">An unknown error occurred.</Notice>
);

For more complex markup, you can pass any JSX element:

import { Notice } from `@wordpress/components`;

const MyNotice = () => (
    <Notice status="error">
        <p>
            An error occurred: <code>{ errorDetails }</code>.
        </p>
    </Notice>
);

Top ↑

Props

The following props are used to control the behavior of the component.

Top ↑

children: ReactNode

The displayed message of a notice. Also used as the spoken message for assistive technology, unless spokenMessage is provided as an alternative message.

  • Required: Yes

Top ↑

spokenMessage: ReactNode

Used to provide a custom spoken message in place of the children default.

  • Required: No
  • Default: children

Top ↑

status: 'warning' | 'success' | 'error' | 'info'

Determines the color of the notice: warning (yellow), success (green), error (red), or 'info'. By default 'info' will be blue, but if there is a parent Theme component with an accent color prop, the notice will take on that color instead.

  • Required: No
  • Default: info

Top ↑

onRemove: () => void

A function called to dismiss/remove the notice.

  • Required: No
  • Default: noop

Top ↑

politeness: 'polite' | 'assertive'

A politeness level for the notice’s spoken message. Should be provided as one of the valid options for an aria-live attribute value.

  • A value of 'assertive' is to be used for important, and usually time-sensitive, information. It will interrupt anything else the screen reader is announcing in that moment.
  • A value of 'polite' is to be used for advisory information. It should not interrupt what the screen reader is announcing in that moment (the “speech queue”) or interrupt the current task.

Note that this value should be considered a suggestion; assistive technologies may override it based on internal heuristics.

  • Required: No
  • Default: 'assertive' or 'polite', based on the notice status.

Top ↑

isDismissible: boolean

Whether the notice should be dismissible or not

  • Required: No
  • Default: true

Top ↑

onDismiss : () => void

A deprecated alternative to onRemove. This prop is kept for compatibilty reasons but should be avoided.

  • Requiered: No
  • Default: noop

Top ↑

actions: Array<NoticeAction>.

An array of notice actions. Each member object should contain:

  • label: string containing the text of the button/link
  • url: string OR onClick: ( event: SyntheticEvent ) => void to specify what the action does.
  • className: string (optional) to add custom classes to the button styles.
  • noDefaultClasses: boolean (optional) A value of true will remove all default styling.
  • variant: 'primary' | 'secondary' | 'link' (optional) You can denote a primary button action for a notice by passing a value of primary.

The default appearance of an action button is inferred based on whether url or onClick are provided, rendering the button as a link if appropriate. If both props are provided, url takes precedence, and the action button will render as an anchor tag.

Top ↑

  • To create a more prominent message that requires action, use a Modal.
  • For low priority, non-interruptive messsages, use Snackbar.