mirror of
https://github.com/codex-team/editor.js
synced 2026-03-16 07:35:48 +01:00
trying to write docs
This commit is contained in:
Murod Khaydarov
parent
14b36c2fa0
commit
80500aedb4
4 changed files with 9 additions and 397 deletions
|
|
@ -2029,204 +2029,6 @@ var Renderer = function (_Module) {
|
|||
return Renderer;
|
||||
}(Module);
|
||||
|
||||
// module.exports = (function (renderer) {
|
||||
//
|
||||
// let editor = codex.editor;
|
||||
//
|
||||
// /**
|
||||
// * Asyncronously parses input JSON to redactor blocks
|
||||
// */
|
||||
// renderer.makeBlocksFromData = function () {
|
||||
//
|
||||
// /**
|
||||
// * If redactor is empty, add first paragraph to start writing
|
||||
// */
|
||||
// if (editor.core.isEmpty(editor.state.blocks) || !editor.state.blocks.items.length) {
|
||||
//
|
||||
// editor.ui.addInitialBlock();
|
||||
// return;
|
||||
//
|
||||
// }
|
||||
//
|
||||
// Promise.resolve()
|
||||
//
|
||||
// /** First, get JSON from state */
|
||||
// .then(function () {
|
||||
//
|
||||
// return editor.state.blocks;
|
||||
//
|
||||
// })
|
||||
//
|
||||
// /** Then, start to iterate they */
|
||||
// .then(editor.renderer.appendBlocks)
|
||||
//
|
||||
// /** Write log if something goes wrong */
|
||||
// .catch(function (error) {
|
||||
//
|
||||
// editor.core.log('Error while parsing JSON: %o', 'error', error);
|
||||
//
|
||||
// });
|
||||
//
|
||||
// };
|
||||
//
|
||||
// /**
|
||||
// * Parses JSON to blocks
|
||||
// * @param {object} data
|
||||
// * @return Promise -> nodeList
|
||||
// */
|
||||
// renderer.appendBlocks = function (data) {
|
||||
//
|
||||
// var blocks = data.items;
|
||||
//
|
||||
// /**
|
||||
// * Sequence of one-by-one blocks appending
|
||||
// * Uses to save blocks order after async-handler
|
||||
// */
|
||||
// var nodeSequence = Promise.resolve();
|
||||
//
|
||||
// for (var index = 0; index < blocks.length ; index++ ) {
|
||||
//
|
||||
// /** Add node to sequence at specified index */
|
||||
// editor.renderer.appendNodeAtIndex(nodeSequence, blocks, index);
|
||||
//
|
||||
// }
|
||||
//
|
||||
// };
|
||||
//
|
||||
// /**
|
||||
// * Append node at specified index
|
||||
// */
|
||||
// renderer.appendNodeAtIndex = function (nodeSequence, blocks, index) {
|
||||
//
|
||||
// /** We need to append node to sequence */
|
||||
// nodeSequence
|
||||
//
|
||||
// /** first, get node async-aware */
|
||||
// .then(function () {
|
||||
//
|
||||
// return editor.renderer.getNodeAsync(blocks, index);
|
||||
//
|
||||
// })
|
||||
//
|
||||
// /**
|
||||
// * second, compose editor-block from JSON object
|
||||
// */
|
||||
// .then(editor.renderer.createBlockFromData)
|
||||
//
|
||||
// /**
|
||||
// * now insert block to redactor
|
||||
// */
|
||||
// .then(function (blockData) {
|
||||
//
|
||||
// /**
|
||||
// * blockData has 'block', 'type' and 'stretched' information
|
||||
// */
|
||||
// editor.content.insertBlock(blockData);
|
||||
//
|
||||
// /** Pass created block to next step */
|
||||
// return blockData.block;
|
||||
//
|
||||
// })
|
||||
//
|
||||
// /** Log if something wrong with node */
|
||||
// .catch(function (error) {
|
||||
//
|
||||
// editor.core.log('Node skipped while parsing because %o', 'error', error);
|
||||
//
|
||||
// });
|
||||
//
|
||||
// };
|
||||
//
|
||||
// /**
|
||||
// * Asynchronously returns block data from blocksList by index
|
||||
// * @return Promise to node
|
||||
// */
|
||||
// renderer.getNodeAsync = function (blocksList, index) {
|
||||
//
|
||||
// return Promise.resolve().then(function () {
|
||||
//
|
||||
// return {
|
||||
// tool : blocksList[index],
|
||||
// position : index
|
||||
// };
|
||||
//
|
||||
// });
|
||||
//
|
||||
// };
|
||||
//
|
||||
// /**
|
||||
// * Creates editor block by JSON-data
|
||||
// *
|
||||
// * @uses render method of each plugin
|
||||
// *
|
||||
// * @param {Object} toolData.tool
|
||||
// * { header : {
|
||||
// * text: '',
|
||||
// * type: 'H3', ...
|
||||
// * }
|
||||
// * }
|
||||
// * @param {Number} toolData.position - index in input-blocks array
|
||||
// * @return {Object} with type and Element
|
||||
// */
|
||||
// renderer.createBlockFromData = function ( toolData ) {
|
||||
//
|
||||
// /** New parser */
|
||||
// var block,
|
||||
// tool = toolData.tool,
|
||||
// pluginName = tool.type;
|
||||
//
|
||||
// /** Get first key of object that stores plugin name */
|
||||
// // for (var pluginName in blockData) break;
|
||||
//
|
||||
// /** Check for plugin existance */
|
||||
// if (!editor.tools[pluginName]) {
|
||||
//
|
||||
// throw Error(`Plugin «${pluginName}» not found`);
|
||||
//
|
||||
// }
|
||||
//
|
||||
// /** Check for plugin having render method */
|
||||
// if (typeof editor.tools[pluginName].render != 'function') {
|
||||
//
|
||||
// throw Error(`Plugin «${pluginName}» must have «render» method`);
|
||||
//
|
||||
// }
|
||||
//
|
||||
// if ( editor.tools[pluginName].available === false ) {
|
||||
//
|
||||
// block = editor.draw.unavailableBlock();
|
||||
//
|
||||
// block.innerHTML = editor.tools[pluginName].loadingMessage;
|
||||
//
|
||||
// /**
|
||||
// * Saver will extract data from initial block data by position in array
|
||||
// */
|
||||
// block.dataset.inputPosition = toolData.position;
|
||||
//
|
||||
// } else {
|
||||
//
|
||||
// /** New Parser */
|
||||
// block = editor.tools[pluginName].render(tool.data);
|
||||
//
|
||||
// }
|
||||
//
|
||||
// /** is first-level block stretched */
|
||||
// var stretched = editor.tools[pluginName].isStretched || false;
|
||||
//
|
||||
// /** Retrun type and block */
|
||||
// return {
|
||||
// type : pluginName,
|
||||
// block : block,
|
||||
// stretched : stretched
|
||||
// };
|
||||
//
|
||||
// };
|
||||
//
|
||||
// return renderer;
|
||||
//
|
||||
// })({});
|
||||
|
||||
|
||||
Renderer.displayName = "Renderer";
|
||||
exports.default = Renderer;
|
||||
module.exports = exports["default"];
|
||||
|
|
|
|||
File diff suppressed because one or more lines are too long
7
docs/renderer.md
Normal file
7
docs/renderer.md
Normal file
|
|
@ -0,0 +1,7 @@
|
|||
# CodeX Editor Tools
|
||||
|
||||
`Renderer` is class that is responsible for rendering JSON data to HTML.
|
||||
|
||||
Inside it uses BlockManager to compose block list bounded to the Tool instance.
|
||||
|
||||
## Methods
|
||||
|
|
@ -84,201 +84,4 @@ export default class Renderer extends Module {
|
|||
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
// module.exports = (function (renderer) {
|
||||
//
|
||||
// let editor = codex.editor;
|
||||
//
|
||||
// /**
|
||||
// * Asyncronously parses input JSON to redactor blocks
|
||||
// */
|
||||
// renderer.makeBlocksFromData = function () {
|
||||
//
|
||||
// /**
|
||||
// * If redactor is empty, add first paragraph to start writing
|
||||
// */
|
||||
// if (editor.core.isEmpty(editor.state.blocks) || !editor.state.blocks.items.length) {
|
||||
//
|
||||
// editor.ui.addInitialBlock();
|
||||
// return;
|
||||
//
|
||||
// }
|
||||
//
|
||||
// Promise.resolve()
|
||||
//
|
||||
// /** First, get JSON from state */
|
||||
// .then(function () {
|
||||
//
|
||||
// return editor.state.blocks;
|
||||
//
|
||||
// })
|
||||
//
|
||||
// /** Then, start to iterate they */
|
||||
// .then(editor.renderer.appendBlocks)
|
||||
//
|
||||
// /** Write log if something goes wrong */
|
||||
// .catch(function (error) {
|
||||
//
|
||||
// editor.core.log('Error while parsing JSON: %o', 'error', error);
|
||||
//
|
||||
// });
|
||||
//
|
||||
// };
|
||||
//
|
||||
// /**
|
||||
// * Parses JSON to blocks
|
||||
// * @param {object} data
|
||||
// * @return Promise -> nodeList
|
||||
// */
|
||||
// renderer.appendBlocks = function (data) {
|
||||
//
|
||||
// var blocks = data.items;
|
||||
//
|
||||
// /**
|
||||
// * Sequence of one-by-one blocks appending
|
||||
// * Uses to save blocks order after async-handler
|
||||
// */
|
||||
// var nodeSequence = Promise.resolve();
|
||||
//
|
||||
// for (var index = 0; index < blocks.length ; index++ ) {
|
||||
//
|
||||
// /** Add node to sequence at specified index */
|
||||
// editor.renderer.appendNodeAtIndex(nodeSequence, blocks, index);
|
||||
//
|
||||
// }
|
||||
//
|
||||
// };
|
||||
//
|
||||
// /**
|
||||
// * Append node at specified index
|
||||
// */
|
||||
// renderer.appendNodeAtIndex = function (nodeSequence, blocks, index) {
|
||||
//
|
||||
// /** We need to append node to sequence */
|
||||
// nodeSequence
|
||||
//
|
||||
// /** first, get node async-aware */
|
||||
// .then(function () {
|
||||
//
|
||||
// return editor.renderer.getNodeAsync(blocks, index);
|
||||
//
|
||||
// })
|
||||
//
|
||||
// /**
|
||||
// * second, compose editor-block from JSON object
|
||||
// */
|
||||
// .then(editor.renderer.createBlockFromData)
|
||||
//
|
||||
// /**
|
||||
// * now insert block to redactor
|
||||
// */
|
||||
// .then(function (blockData) {
|
||||
//
|
||||
// /**
|
||||
// * blockData has 'block', 'type' and 'stretched' information
|
||||
// */
|
||||
// editor.content.insertBlock(blockData);
|
||||
//
|
||||
// /** Pass created block to next step */
|
||||
// return blockData.block;
|
||||
//
|
||||
// })
|
||||
//
|
||||
// /** Log if something wrong with node */
|
||||
// .catch(function (error) {
|
||||
//
|
||||
// editor.core.log('Node skipped while parsing because %o', 'error', error);
|
||||
//
|
||||
// });
|
||||
//
|
||||
// };
|
||||
//
|
||||
// /**
|
||||
// * Asynchronously returns block data from blocksList by index
|
||||
// * @return Promise to node
|
||||
// */
|
||||
// renderer.getNodeAsync = function (blocksList, index) {
|
||||
//
|
||||
// return Promise.resolve().then(function () {
|
||||
//
|
||||
// return {
|
||||
// tool : blocksList[index],
|
||||
// position : index
|
||||
// };
|
||||
//
|
||||
// });
|
||||
//
|
||||
// };
|
||||
//
|
||||
// /**
|
||||
// * Creates editor block by JSON-data
|
||||
// *
|
||||
// * @uses render method of each plugin
|
||||
// *
|
||||
// * @param {Object} toolData.tool
|
||||
// * { header : {
|
||||
// * text: '',
|
||||
// * type: 'H3', ...
|
||||
// * }
|
||||
// * }
|
||||
// * @param {Number} toolData.position - index in input-blocks array
|
||||
// * @return {Object} with type and Element
|
||||
// */
|
||||
// renderer.createBlockFromData = function ( toolData ) {
|
||||
//
|
||||
// /** New parser */
|
||||
// var block,
|
||||
// tool = toolData.tool,
|
||||
// pluginName = tool.type;
|
||||
//
|
||||
// /** Get first key of object that stores plugin name */
|
||||
// // for (var pluginName in blockData) break;
|
||||
//
|
||||
// /** Check for plugin existance */
|
||||
// if (!editor.tools[pluginName]) {
|
||||
//
|
||||
// throw Error(`Plugin «${pluginName}» not found`);
|
||||
//
|
||||
// }
|
||||
//
|
||||
// /** Check for plugin having render method */
|
||||
// if (typeof editor.tools[pluginName].render != 'function') {
|
||||
//
|
||||
// throw Error(`Plugin «${pluginName}» must have «render» method`);
|
||||
//
|
||||
// }
|
||||
//
|
||||
// if ( editor.tools[pluginName].available === false ) {
|
||||
//
|
||||
// block = editor.draw.unavailableBlock();
|
||||
//
|
||||
// block.innerHTML = editor.tools[pluginName].loadingMessage;
|
||||
//
|
||||
// /**
|
||||
// * Saver will extract data from initial block data by position in array
|
||||
// */
|
||||
// block.dataset.inputPosition = toolData.position;
|
||||
//
|
||||
// } else {
|
||||
//
|
||||
// /** New Parser */
|
||||
// block = editor.tools[pluginName].render(tool.data);
|
||||
//
|
||||
// }
|
||||
//
|
||||
// /** is first-level block stretched */
|
||||
// var stretched = editor.tools[pluginName].isStretched || false;
|
||||
//
|
||||
// /** Retrun type and block */
|
||||
// return {
|
||||
// type : pluginName,
|
||||
// block : block,
|
||||
// stretched : stretched
|
||||
// };
|
||||
//
|
||||
// };
|
||||
//
|
||||
// return renderer;
|
||||
//
|
||||
// })({});
|
||||
}
|
||||
Loading…
Add table
Add a link
Reference in a new issue