mirror of
https://github.com/codex-team/editor.js
synced 2024-06-02 14:02:17 +02:00
bcdfcdadbc
* Move all modules to ts * It works * Update README.md Co-Authored-By: gohabereg <gohabereg@users.noreply.github.com> * Interfaces * Interfaces * Move depending interfaces to external types * Update README.md * update tools * add some docs * Add some fixes * Add desctiprion for Block declaration and Core properties * Fixes due comments : * Remove Block from external types * Bump version * Update src/components/modules/tools.ts Co-Authored-By: gohabereg <gohabereg@users.noreply.github.com> * Update src/components/core.ts Co-Authored-By: gohabereg <gohabereg@users.noreply.github.com> * Rename gteBlockHTMLByIndex to getBlockByIndex * Remove unnecessary constructors * Clean up bindEvents method * Add InlineToolConstructable interface * Delete legacy notifications class * Fix zero-configuration bugs * Update inline tools and block tunes constructors
81 lines
1.8 KiB
TypeScript
81 lines
1.8 KiB
TypeScript
import Module from '../__module';
|
|
import _, {ChainData} from '../utils';
|
|
import {BlockToolData} from '../../../types';
|
|
|
|
/**
|
|
* Codex Editor Renderer Module
|
|
*
|
|
* @module Renderer
|
|
* @author CodeX Team
|
|
*
|
|
* @version 2.0.0
|
|
*/
|
|
export default class Renderer extends Module {
|
|
/**
|
|
* @typedef {Object} RendererBlocks
|
|
* @property {String} type - tool name
|
|
* @property {Object} data - tool data
|
|
*/
|
|
|
|
/**
|
|
* @example
|
|
*
|
|
* blocks: [
|
|
* {
|
|
* type : 'paragraph',
|
|
* data : {
|
|
* text : 'Hello from Codex!'
|
|
* }
|
|
* },
|
|
* {
|
|
* type : 'paragraph',
|
|
* data : {
|
|
* text : 'Leave feedback if you like it!'
|
|
* }
|
|
* },
|
|
* ]
|
|
*
|
|
*/
|
|
|
|
/**
|
|
* Make plugin blocks from array of plugin`s data
|
|
* @param {RendererBlocks[]} blocks
|
|
*/
|
|
public render(blocks: BlockToolData[]): Promise<void> {
|
|
const chainData = blocks.map((block) => ({function: () => this.insertBlock(block)}));
|
|
|
|
return _.sequence(chainData as ChainData[]);
|
|
}
|
|
|
|
/**
|
|
* Get plugin instance
|
|
* Add plugin instance to BlockManager
|
|
* Insert block to working zone
|
|
*
|
|
* @param {Object} item
|
|
* @returns {Promise<void>}
|
|
* @private
|
|
*/
|
|
public async insertBlock(item): Promise<void> {
|
|
const tool = item.type;
|
|
const data = item.data;
|
|
const settings = item.settings;
|
|
|
|
if (tool in this.Editor.Tools.available) {
|
|
try {
|
|
this.Editor.BlockManager.insert(tool, data, settings);
|
|
} catch (error) {
|
|
_.log(`Block «${tool}» skipped because of plugins error`, 'warn', data);
|
|
throw Error(error);
|
|
}
|
|
} else {
|
|
/**
|
|
* @todo show warning notification message
|
|
*
|
|
* `${tool} blocks was skipped.`
|
|
*/
|
|
_.log(`Tool «${tool}» is not found. Check 'tools' property at your initial CodeX Editor config.`, 'warn');
|
|
}
|
|
}
|
|
}
|