Browse Source

Update BlockManager API

pull/3725/head
Artur Arseniev 5 years ago
parent
commit
776815a326
  1. 8
      docs/api/block_manager.md
  2. 7
      src/block_manager/index.js

8
docs/api/block_manager.md

@ -28,6 +28,8 @@ const blockManager = editor.BlockManager;
* [getContainer][9]
* [render][10]
[Block]: block.html
## getConfig
Get configuration object
@ -69,7 +71,7 @@ blockManager.add('h1-block', {
});
```
Returns **Block** Added block
Returns **[Block]** Added block
## get
@ -87,6 +89,8 @@ console.log(JSON.stringify(block));
// {label: 'Heading', content: '<h1>Put your ...', ...}
```
Returns **[Block]**
## getAll
Return all blocks
@ -123,7 +127,7 @@ const id = 'button';
blockManager.remove(id);
```
Returns **Block** Removed block
Returns **[Block]** Removed block
## getCategories

7
src/block_manager/index.js

@ -23,6 +23,8 @@
* * [getContainer](#getcontainer)
* * [render](#render)
*
* [Block]: block.html
*
* @module BlockManager
*/
import { isElement } from 'underscore';
@ -126,7 +128,7 @@ export default () => {
* The string will be converted in:
* 'someid' => {id: 'someid', label: 'someid'}
* @param {Object} [opts.attributes={}] Block attributes
* @return {Block} Added block
* @returns {[Block]} Added block
* @example
* blockManager.add('h1-block', {
* label: 'Heading',
@ -146,6 +148,7 @@ export default () => {
/**
* Return the block by id
* @param {string} id Block id
* @returns {[Block]}
* @example
* const block = blockManager.get('h1-block');
* console.log(JSON.stringify(block));
@ -178,7 +181,7 @@ export default () => {
/**
* Remove a block by id
* @param {string} id Block id
* @return {Block} Removed block
* @returns {[Block]} Removed block
* @example
* // Id of the block which need to be removed
* const id = 'button';

Loading…
Cancel
Save