[Feature] BlockAPI Interface #1075
There are no files selected for viewing
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 { | ||
neSpecc marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| 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 { | ||
|
There was a problem hiding this comment. There can be a misunderstanding with existed Tool config term. There was a problem hiding this comment. That's exactly the ToolConfig object |
||
| 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.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
what is a tool name?