@wordpress/界面

Interface Package包含启动新WordPress屏幕作为Edit Post或Edit Site的基础。该软件包提供了一个数据存储和一组组件。存储区有助于包含屏幕所需的通用数据(例如,活动区域)。信息在整个屏幕重新加载期间保持不变。这些组件允许用户实现工具条或菜单项等功能。默认情况下,第三方插件可以对其进行扩展。

安装

安装模块

npm install@wordpress/interface--保存

此包假定您的代码将在2015年欧洲标准+环境。如果您使用的环境对此类语言功能和API的支持有限或不支持,您应该包括polyfill发货@wordpress/babel预设在代码中。

API使用

补充领域

此组件以互补地标–文档的支持部分,旨在补充DOM层次结构中类似级别的主要内容,但与主要内容分离后仍有意义。

补充面积补充区域。狭槽形成一个槽填充对来渲染互补区域。多个互补区域可以同时渲染表示不同互补区域的组件,但根据启用的互补区域,插槽上只显示一个。

可以通过使用存储来控制启用哪种补充:

以下是如何使用门店控制活动补充区域的一些示例:

wp.数据.select('核心/接口').getActiveComplementaryArea(“核心”);//->“编辑帖子/文档”wp.数据.dispatch(“核心/接口”).enableComplementaryArea('core','edit-post/block');wp.数据.select('核心/接口').getActiveComplementaryArea(“核心”);//->“编辑帖子/块”wp.数据.dispatch(“核心/接口”).disableComplementaryArea(“核心”);wp.数据.select(“核心/接口”).getActiveComplementaryArea(“核心”);//->空

固定的项目

固定项目固定项目。狭槽形成一个插槽填充对,以呈现作为收藏夹列表的固定项目(或区域),类似于Chrome菜单中列出的浏览器扩展。

示例用法:互补区域组件使用固定项目并自动为标记为收藏夹的互补区域添加固定项目。

wp.data.select('core/interface').isItemPinned('core’,'edit-post-block-patterns/sidebar');//->假wp.data.dispatch(“core/interface”).pinItem(“core”,“edit-post-block-patterns/sidebar”);wp.data.select('core/interface').isItemPinned('core’,'edit-post-block-patterns/sidebar');//->正确wp.data.dispatch(“core/interface”).unpinItem(“core”,“edit-post-block-patterns/sidebar”);wp.data.select(“core/interface”).isItemPinned(“core”,“edit-post-block-patterns/sidebar”);->

偏好

接口包为实现编辑器首选项提供了一些帮助程序。

特征

功能是用于打开或关闭特定编辑器功能的布尔值。

在编辑器初始化时为任何功能设置默认值:

从“@wordpress/data”导入{dispatch};从“@wordpress/interface”导入{store as interfaceStore};函数initialize(){// ...分派(interfaceStore).setFeatureDefaults(“namespace/editor-or-plugin-name”,{myFeatureName:true,});// ...}

使用切换功能动作和功能处于活动状态用于切换应用程序中的功能的选择器:

wp.数据.select('核心/接口').isFeatureActive('namespace/editor-or-plugin-name','myFeatureName');//真的wp.数据.dispatch(“核心/接口”).thoggFeature(“名称空间/编辑器或插件名称”,“myFeatureName”);wp.数据.select('核心/接口').isFeatureActive('namespace/editor-or-plugin-name','myFeatureName');//

参与此包

这是古腾堡项目的一部分。该项目被组织为单回购项目。它由多个独立的软件包组成,每个包都有特定的用途。此monorepo中的包发布到净现值并由使用WordPress(文字出版社)以及其他软件项目。

要了解更多关于对这个包或古腾堡整体贡献的信息,请阅读该项目的主要内容贡献者指南.