gutenbergdocs/docs/reference-guides/data/data-core-block-directory.md
2025-10-22 01:40:18 +08:00

3.9 KiB
Raw Blame History

区块目录

命名空间:core/block-directory

选择器

getDownloadableBlocks

返回可用的未安装区块。

参数

  • state Object: 全局应用状态
  • filterValue string: 搜索关键词

返回值

  • Array: 可下载区块列表

getErrorNoticeForBlock

返回指定区块的错误通知。

参数

  • state Object: 全局应用状态
  • blockId string: 区块插件ID例如my-block

返回值

  • string|boolean: 错误文本,若无错误则返回 false

getErrorNotices

返回所有区块错误通知。

参数

  • state Object: 全局应用状态

返回值

  • Object: 包含错误通知的对象

getInstalledBlockTypes

返回当前会话中已在服务器上安装的区块类型。

参数

  • state Object: 全局应用状态

返回值

  • Array: 区块类型项

getNewBlockTypes

返回已在服务器安装并在当前文章中使用的区块类型。

参数

  • state Object: 全局应用状态

返回值

  • Array: 区块类型项

getUnusedBlockTypes

返回已在服务器安装但未在当前文章中使用的区块类型。

参数

  • state Object: 全局应用状态

返回值

  • Array: 区块类型项

isInstalling

判断区块插件是否正在安装中。

参数

  • state Object: 全局应用状态
  • blockId string: 区块ID

返回值

  • boolean: 该区块是否正在安装

isRequestingDownloadableBlocks

判断应用是否正在请求可下载区块。

参数

  • state Object: 全局应用状态
  • filterValue string: 搜索关键词

返回值

  • boolean: 是否正在请求区块列表

操作

addInstalledBlockType

返回用于将区块类型添加到"新安装"跟踪列表的操作对象。

参数

  • item Object: 包含区块ID和名称的区块项

返回值

  • Object: 操作对象

clearErrorNotice

清空指定区块的错误通知。

参数

  • blockId string: 区块插件ID例如my-block

返回值

  • Object: 操作对象

fetchDownloadableBlocks

返回用于表示正在请求和加载可下载区块的操作对象。

参数

  • filterValue string: 搜索关键词

返回值

  • Object: 操作对象

installBlockType

触发安装区块插件的操作。

参数

  • block Object: 搜索返回的区块项

返回值

  • boolean: 区块是否成功安装和加载

receiveDownloadableBlocks

返回用于表示可下载区块已更新的操作对象。

参数

  • downloadableBlocks Array: 可下载区块
  • filterValue string: 搜索关键词

返回值

  • Object: 操作对象

removeInstalledBlockType

返回用于从"新安装"跟踪列表中移除区块类型的操作对象。

参数

  • item string: 包含区块ID和名称的区块项

返回值

  • Object: 操作对象

setErrorNotice

设置要为用户显示的指定区块错误通知。

参数

  • blockId string: 区块插件ID例如my-block
  • message string: 通知中显示的消息
  • isFatal boolean: 用户是否可以从错误中恢复

返回值

  • Object: 操作对象

setIsInstalling

返回用于指示安装进度的操作对象。

参数

  • blockId string:
  • isInstalling boolean:

返回值

  • Object: 操作对象

uninstallBlockType

触发卸载区块插件的操作。

参数

  • block Object: 区块类型对象