forked from codex-team/editor.js
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[Feature] BlockAPI Interface (codex-team#1075)
- Loading branch information
Showing
29 changed files
with
544 additions
and
226 deletions.
There are no files selected for viewing
Large diffs are not rendered by default.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,114 @@ | ||
| import Block from './index'; | ||
| import { BlockToolData, ToolConfig } from '../../../types/tools'; | ||
| import { SavedData } from '../../types-internal/block-data'; | ||
| import { BlockAPI as BlockAPIInterface } from '../../../types/api'; | ||
|
|
||
| /** | ||
| * Constructs new BlockAPI object | ||
| * | ||
| * @class | ||
| * | ||
| * @param {Block} block - Block to expose | ||
| */ | ||
| function BlockAPI(block: Block): void { | ||
| const blockAPI: BlockAPIInterface = { | ||
| /** | ||
| * Tool name | ||
| * | ||
| * @returns {string} | ||
| */ | ||
| get name(): string { | ||
| return block.name; | ||
| }, | ||
|
|
||
| /** | ||
| * Tool config passed on Editor's initialization | ||
| * | ||
| * @returns {ToolConfig} | ||
| */ | ||
| get config(): ToolConfig { | ||
| return block.config; | ||
| }, | ||
|
|
||
| /** | ||
| * .ce-block element, that wraps plugin contents | ||
| * | ||
| * @returns {HTMLElement} | ||
| */ | ||
| get holder(): HTMLElement { | ||
| return block.holder; | ||
| }, | ||
|
|
||
| /** | ||
| * True if Block content is empty | ||
| * | ||
| * @returns {boolean} | ||
| */ | ||
| get isEmpty(): boolean { | ||
| return block.isEmpty; | ||
| }, | ||
|
|
||
| /** | ||
| * True if Block is selected with Cross-Block selection | ||
| * | ||
| * @returns {boolean} | ||
| */ | ||
| get selected(): boolean { | ||
| return block.selected; | ||
| }, | ||
|
|
||
| /** | ||
| * Set Block's stretch state | ||
| * | ||
| * @param {boolean} state — state to set | ||
| */ | ||
| set stretched(state: boolean) { | ||
| block.stretched = state; | ||
| }, | ||
|
|
||
| /** | ||
| * True if Block is stretched | ||
| * | ||
| * @returns {boolean} | ||
| */ | ||
| get stretched(): boolean { | ||
| return block.stretched; | ||
| }, | ||
|
|
||
| /** | ||
| * Call Tool method with errors handler under-the-hood | ||
| * | ||
| * @param {string} methodName - method to call | ||
| * @param {object} param - object with parameters | ||
| * | ||
| * @returns {void} | ||
| */ | ||
| call(methodName: string, param?: object): void { | ||
| block.call(methodName, param); | ||
| }, | ||
|
|
||
| /** | ||
| * Save Block content | ||
| * | ||
| * @returns {Promise<void|SavedData>} | ||
| */ | ||
| save(): Promise<void|SavedData> { | ||
| return block.save(); | ||
| }, | ||
|
|
||
| /** | ||
| * Validate Block data | ||
| * | ||
| * @param {BlockToolData} data - data to validate | ||
| * | ||
| * @returns {Promise<boolean>} | ||
| */ | ||
| validate(data: BlockToolData): Promise<boolean> { | ||
| return block.validate(data); | ||
| }, | ||
| }; | ||
|
|
||
| Object.setPrototypeOf(this, blockAPI); | ||
| } | ||
|
|
||
| export default BlockAPI; |
Oops, something went wrong.