withNotices 是一个 React 高阶组件,通常用于在原始组件中添加发布通知消息的功能。
使用 withNotices 包装原始组件后,该组件将被封装并附加额外的属性:noticeOperations、noticeUI 和 noticeList。
noticeOperations
包含若干用于向站点添加通知的实用函数。
# createNotice
作为 prop 传递的函数,用于添加新的通知。
参数
- notice
object: 要添加的通知对象。
# createErrorNotice
作为 prop 传递的函数,用于添加新的错误通知。
参数
- msg
string: 通知的错误消息。
# removeAllNotices
移除所有通知的函数。
# removeNotice
按 ID 移除通知的函数。
参数
- id
string: 要移除的通知 ID。
#noticeUi
已渲染的 NoticeList。
#noticeList
待显示的注记对象数组。
用法
import { withNotices, Button } from '@wordpress/components';
const MyComponentWithNotices = withNotices(
( { noticeOperations, noticeUI } ) => {
const addError = () =>
noticeOperations.createErrorNotice( 'Error message' );
return (
<div>
{ noticeUI }
<Button variant="secondary" onClick={ addError }>
Add error
</Button>
</div>
);
}
);