@wordpress/components
Version:
UI components for WordPress.
113 lines (101 loc) • 2.79 kB
JavaScript
import { createElement } from "@wordpress/element";
/**
* External dependencies
*/
import { noop } from 'lodash';
import classnames from 'classnames';
/**
* WordPress dependencies
*/
import { __ } from '@wordpress/i18n';
import { RawHTML, useEffect, renderToString } from '@wordpress/element';
import { speak } from '@wordpress/a11y';
import { close } from '@wordpress/icons';
/**
* Internal dependencies
*/
import { Button } from '../';
/** @typedef {import('@wordpress/element').WPElement} WPElement */
/**
* Custom hook which announces the message with the given politeness, if a
* valid message is provided.
*
* @param {string|WPElement} [message] Message to announce.
* @param {'polite'|'assertive'} politeness Politeness to announce.
*/
function useSpokenMessage(message, politeness) {
const spokenMessage = typeof message === 'string' ? message : renderToString(message);
useEffect(() => {
if (spokenMessage) {
speak(spokenMessage, politeness);
}
}, [spokenMessage, politeness]);
}
/**
* Given a notice status, returns an assumed default politeness for the status.
* Defaults to 'assertive'.
*
* @param {string} [status] Notice status.
*
* @return {'polite'|'assertive'} Notice politeness.
*/
function getDefaultPoliteness(status) {
switch (status) {
case 'success':
case 'warning':
case 'info':
return 'polite';
case 'error':
default:
return 'assertive';
}
}
function Notice({
className,
status = 'info',
children,
spokenMessage = children,
onRemove = noop,
isDismissible = true,
actions = [],
politeness = getDefaultPoliteness(status),
__unstableHTML
}) {
useSpokenMessage(spokenMessage, politeness);
const classes = classnames(className, 'components-notice', 'is-' + status, {
'is-dismissible': isDismissible
});
if (__unstableHTML) {
children = createElement(RawHTML, null, children);
}
return createElement("div", {
className: classes
}, createElement("div", {
className: "components-notice__content"
}, children, actions.map(({
className: buttonCustomClasses,
label,
isPrimary,
noDefaultClasses = false,
onClick,
url
}, index) => {
return createElement(Button, {
key: index,
href: url,
isPrimary: isPrimary,
isSecondary: !noDefaultClasses && !url,
isLink: !noDefaultClasses && !!url,
onClick: url ? undefined : onClick,
className: classnames('components-notice__action', buttonCustomClasses)
}, label);
})), isDismissible && createElement(Button, {
className: "components-notice__dismiss",
icon: close,
label: __('Dismiss this notice'),
onClick: onRemove,
showTooltip: false
}));
}
export default Notice;
//# sourceMappingURL=index.js.map