通知数据

命名空间:核心/通知.

选择器

获取通知

将所有通知作为数组返回,对于给定的上下文也是可选的。默认为全局上下文。

用法

从“@wordpress/data”导入{useSelect};从“@wordpress/notices”导入{store as noticesStore};常量示例组件=()=>{constnotices=useSelect((select)=>选择(noticesStore).getNotices());返回(<ul>{notices.map((notice)=>(<li key={notice.ID}>{notice.content}</li>) ) }</ul>);};

参数

  • 状态 对象:通知状态。
  • 上下文 ?一串:可选分组上下文。

退换商品

  • WP通知[]:通知数组。

行动

创建错误通知

返回用于发出创建错误通知的信号的操作对象。请参阅创建通知用于选项文档。

相关的

  • 创建通知

用法

从'@wordpress/i18n'导入{__};从“@wordpress/data”导入{useDispatch};从“@wordpress/notices”导入{store as noticesStore};从“@wordpress/components”导入{Button};常量示例组件=()=>{const{createErrorNotice}=useDispatch(noticesStore);返回(<按钮onClick={()=>createErrorNotice(__('发生错误!'){type:“snackbar”,explicitDismiss:true,} )}>{ __('使用显式关闭按钮生成snackbar错误通知。') }</按钮>);};

参数

  • 内容 一串:通知消息。
  • 选项 [对象]:可选通知选项。

退换商品

  • 对象:Action对象。

创建信息通知

返回一个操作对象,该对象用于发出要创建信息通知的信号。请参阅创建通知用于选项文档。

相关的

  • 创建通知

用法

从'@wordpress/i18n'导入{__};从“@wordpress/data”导入{useDispatch};从“@wordpress/notices”导入{store as noticesStore};从“@wordpress/components”导入{Button};常量示例组件=()=>{const{createInfoNotice}=useDispatch(noticesStore);返回(<按钮onClick={()=>createInfoNotice(__('发生了什么!'){isDismissible:错误,} )}>{__('生成一个不能被驳回的通知。')}</按钮>);};

参数

  • 内容 一串:通知消息。
  • 选项 [对象]:可选通知选项。

退换商品

  • 对象:Action对象。

创建通知

返回用于发出创建通知的信号的操作对象。

用法

从'@wordpress/i18n'导入{__};从“@wordpress/data”导入{useDispatch};从“@wordpress/notices”导入{store as noticesStore};从“@wordpress/components”导入{Button};常量示例组件=()=>{const{createNotice}=useDispatch(noticesStore);返回(<按钮onClick={()=>createNotice('成功',__('通知消息'))}>{__('生成成功通知!')}</按钮>);};

参数

  • 地位 字符串|未定义:通知状态(如果传递了undefined,则为“info”)。
  • 内容 一串:通知消息。
  • 选项 [对象]:通知选项。
  • 选项.context [字符串]:分组通知的上下文。
  • 选项.id [字符串]:通知标识符。如果未指定,则自动分配。
  • 选项.isDismissible [布尔值]:用户是否可以解除通知。
  • 选项.类型 [字符串]:通知类型,其中之一违约,或快餐店.
  • 选项.峰值 [布尔值]:是否应向屏幕阅读器公布通知内容。
  • 选项.操作 [数组<WPNoticeAction>]:用户操作将显示通知。
  • 选项.icon [字符串]:与通知一起显示的图标。仅在类型设置为时使用快餐店.
  • options.explicitDismiss选项 [布尔值]:通知是否包含明确的解除按钮,并且不能通过单击通知正文解除。仅当类型设置为时适用快餐店.
  • 选项.onDismiss [功能]:通知被驳回时调用。

退换商品

  • 对象:Action对象。

创建成功通知

返回用于发出创建成功通知的信号的操作对象。请参阅创建通知用于选项文档。

相关的

  • 创建通知

用法

从'@wordpress/i18n'导入{__};从“@wordpress/data”导入{useDispatch};从“@wordpress/notices”导入{store as noticesStore};从“@wordpress/components”导入{Button};常量示例组件=()=>{const{createSuccessNotice}=useDispatch(noticesStore);返回(<按钮onClick={()=>创建成功通知(__('成功!'){type:“snackbar”,图标:'🔥',} )}>{__('生成snackbar成功通知!')}</按钮>);};

参数

  • 内容 一串:通知消息。
  • 选项 [对象]:可选通知选项。

退换商品

  • 对象:Action对象。

创建警告通知

返回用于发出创建警告通知的信号的操作对象。请参阅创建通知用于选项文档。

相关的

  • 创建通知

用法

从'@wordpress/i18n'导入{__};从“@wordpress/data”导入{useDispatch};从“@wordpress/notices”导入{store as noticesStore};从“@wordpress/components”导入{Button};常量示例组件=()=>{const{创建警告通知,创建信息通知}=使用Dispatch(noticesStore);返回(<按钮onClick={()=>创建警告通知(__('警告!'){onDismiss:()=>{创建信息通知(__(“警告已解除!”));},} )}>{__('使用onDismiss回调生成警告通知')}</按钮>);};

参数

  • 内容 一串:通知消息。
  • 选项 [对象]:可选通知选项。

退换商品

  • 对象:Action对象。

删除所有通知

从给定上下文中删除所有通知。默认为默认上下文。

用法

从'@wordpress/i18n'导入{__};从“@wordpress/data”导入{useDispatch,useSelect};从“@wordpress/notices”导入{store as noticesStore};从“@wordpress/components”导入{Button};export const ExampleComponent=()=>{constnotices=useSelect((select)=>选择(noticesStore).getNotices());const{removeAllNotices}=useDispatch(noticesStore);返回(<><ul>{notices.map((notice)=>(<li键={notice.id}>{notice.content}</li>) ) }</ul><按钮onClick={()=>removeAllNotices()}>{__(“清除所有通知”,“woo-gutenberg-products-block”)}</按钮><Button onClick={()=>removeAllNotices('snackbar')}>{ __('清除所有snackbar通知',“woo-gutenberg-products-block”) }</按钮></>);};

参数

  • 通知类型 一串:要从中删除所有通知的上下文。
  • 上下文 一串:要从中删除所有通知的上下文。

退换商品

  • 对象:Action对象。

删除通知

返回用于发出删除通知的信号的操作对象。

用法

从'@wordpress/i18n'导入{__};从“@wordpress/data”导入{useDispatch};从“@wordpress/notices”导入{store as noticesStore};从“@wordpress/components”导入{Button};常量示例组件=()=>{constnotices=useSelect((select)=>选择(noticesStore).getNotices());const{createWarningNotice,removeNotice}=useDispatch(noticesStore);返回(<><按钮onClick={()=>创建警告通知(__('警告!'){isDismissible:false,} )}>{__('生成通知')}</按钮>{通知长度>0&&(<Button onClick={()=>removeNotice(notices[0].id)}>{__('删除通知')}</按钮>) }</>);};

参数

  • 身份证件 一串:注意唯一标识符。
  • 上下文 [字符串]:用于显示通知的可选上下文(分组)。默认为默认上下文。

退换商品

  • 对象:Action对象。

删除通知

返回用于发出要删除多个通知的信号的操作对象。

用法

从'@wordpress/i18n'导入{__};从“@wordpress/data”导入{useDispatch,useSelect};从“@wordpress/notices”导入{store as noticesStore};从“@wordpress/components”导入{Button};常量示例组件=()=>{constnotices=useSelect((select)=>选择(noticesStore).getNotices());const{removeNotifications}=useDispatch(noticesStore);返回(<><ul>{notices.map((notice)=>(<li键={notice.id}>{notice.content}</li>) ) }</ul><按钮onClick={()=>removeNotices(notices.map(({id})=>id))}>{__('清除所有通知')}</按钮></>);};

参数

  • 身份证 字符串[]:唯一通知标识符列表。
  • 上下文 [字符串]:用于显示通知的可选上下文(分组)。默认为默认上下文。

退换商品

  • 对象:Action对象。