223 lines
3.9 KiB
Markdown
223 lines
3.9 KiB
Markdown
# 区块目录
|
||
|
||
命名空间：`core/block-directory`
|
||
|
||
## 选择器
|
||
|
||
<!-- START TOKEN(Autogenerated selectors|../../../packages/block-directory/src/store/selectors.js) -->
|
||
|
||
### 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`: 是否正在请求区块列表
|
||
|
||
<!-- END TOKEN(Autogenerated selectors|../../../packages/block-directory/src/store/selectors.js) -->
|
||
|
||
## 操作
|
||
|
||
<!-- START TOKEN(Autogenerated actions|../../../packages/block-directory/src/store/actions.js) -->
|
||
|
||
### 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`: 区块类型对象
|
||
|
||
<!-- END TOKEN(Autogenerated actions|../../../packages/block-directory/src/store/actions.js) --> |