用于使用块目录功能扩展编辑器以搜索和安装块的包。
此软件包仅用于WordPress核心。您可以在自己的项目中随意使用它,但请记住,它可能永远不会得到完整的文档记录。
安装模块
npm install@wordpress/block-directory--保存
此包假定您的代码将在2015年+环境。如果您使用的环境对此类语言功能和API的支持有限或不支持,您应该包括polyfill发货@wordpress/babel预设
在代码中。
这个包构建一个独立的JS文件。当用块编辑器加载到页面上时,它扩展了块插入器,以便从WordPress.org搜索块。
为此,它使用__不稳定的插入器菜单扩展
,连接到块类型列表中的插槽填充区域。当用户运行搜索而当前没有安装结果时,它会向WordPress.org发出匹配块的请求。这些列表供用户通过单击过程进行安装安装、激活并将块注入post。保存帖子时,如果未使用块,则将静默卸载以避免混乱。
另请参阅用于搜索WordPress.org的API端点:/wp/v2/块目录/搜索
,以及安装和激活插件:/wp/v2/插件/
.
以下调度操作创建者集可用于返回的对象wp.data.dispatch(“核心/块目录”)
:
返回用于将块类型添加到“新安装”跟踪列表中的操作对象。
参数
退换商品
将特定块的错误通知设置为空。
参数
- 块标识
一串
:块插件的ID。例如:my-block
退换商品
返回一个操作对象,用于发出可下载块已被请求并正在加载的信号。
参数
退换商品
已触发安装块插件的操作。
参数
退换商品
返回用于发出可下载块已更新信号的操作对象。
参数
- 可下载块
阵列
:可下载块。
- 过滤器值
一串
:搜索字符串。
退换商品
返回用于从“新安装”跟踪列表中删除块类型的操作对象。
参数
退换商品
设置要为给定块向用户显示的错误通知。
参数
- 块标识
一串
:块插件的ID。例如:my-block
- 消息
一串
:通知中显示的消息。
- 是致命的
布尔值
:用户是否可以从错误中恢复。
退换商品
返回用于指示正在安装的操作对象。
参数
退换商品
已触发卸载块插件的操作。
参数
以下选择器可用于返回的对象wp.data.select(“核心/块目录”)
:
返回可用的卸载块。
参数
- 状态
对象
:全局应用程序状态。
- 过滤器值
一串
:搜索字符串。
退换商品
返回给定块的错误通知。
参数
- 状态
对象
:全局应用程序状态。
- 块标识
一串
:块插件的ID。例如:my-block
退换商品
字符串|布尔值
:错误文本,如果没有错误,则为false。
返回所有块错误通知。
参数
退换商品
返回此会话中已安装在服务器上的块类型。
参数
退换商品
返回已安装在服务器上并在当前帖子中使用的块类型。
参数
退换商品
返回已安装在服务器上但当前帖子中未使用的块类型。
参数
退换商品
如果正在安装块插件,则返回true。
参数
- 状态
对象
:全局应用程序状态。
- 块标识
一串
:块的Id。
退换商品
如果应用程序请求下载块,则返回true。
参数
- 状态
对象
:全局应用程序状态。
- 过滤器值
一串
:搜索字符串。
退换商品
这是古腾堡项目的一部分。该项目组织为单回购。它由多个独立的软件包组成,每个包都有特定的用途。此monorepo中的包发布到净现值并由使用WordPress(文字出版社)以及其他软件项目。
要了解更多关于对这个包或古腾堡整体贡献的信息,请阅读该项目的主要内容投稿人指南.