This plugin exposes a decorator for blocks of the type `atomic`. You can use it in combination with any kind of plugin that manages a Draft.js block e.g. image or video. Keep in mind the plugin must accept a decorator for the block. The `Simple Focus Example` further down contains an example plugin rendering a colored div.
Select (via mouse or keyboard) a block.
npm install @draft-js-plugins/editor
npm install @draft-js-plugins/focus
The plugin ships with a default styling available at this location in the installed package: node_modules/@draft-js-plugins/focus/lib/plugin.css
npm i style-loader css-loader --save-dev
module.exports = {
module: {
loaders: [
{
test: /plugin\.css$/,
loaders: ['style-loader', 'css'],
},
],
},
};
import '@draft-js-plugins/focus/lib/plugin.css';
import React, { Component } from 'react';
import { convertFromRaw, EditorState } from 'draft-js';
import Editor, { composeDecorators } from '@draft-js-plugins/editor';
import createFocusPlugin from '@draft-js-plugins/focus';
import createColorBlockPlugin from './colorBlockPlugin';
import editorStyles from './editorStyles.module.css';
const focusPlugin = createFocusPlugin();
const decorator = composeDecorators(focusPlugin.decorator);
const colorBlockPlugin = createColorBlockPlugin({ decorator });
const plugins = [focusPlugin, colorBlockPlugin];
/* eslint-disable */
const initialState = {
entityMap: {
0: {
type: 'colorBlock',
mutability: 'IMMUTABLE',
data: {},
},
},
blocks: [
{
key: '9gm3s',
text:
'This is a simple example. Focus the block by clicking on it and change alignment via the toolbar.',
type: 'unstyled',
depth: 0,
inlineStyleRanges: [],
entityRanges: [],
data: {},
},
{
key: 'ov7r',
text: ' ',
type: 'atomic',
depth: 0,
inlineStyleRanges: [],
entityRanges: [
{
offset: 0,
length: 1,
key: 0,
},
],
data: {},
},
{
key: 'e23a8',
text:
'More text here to demonstrate how inline left/right alignment works …',
type: 'unstyled',
depth: 0,
inlineStyleRanges: [],
entityRanges: [],
data: {},
},
],
};
/* eslint-enable */
export default class CustomImageEditor extends Component {
state = {
editorState: EditorState.createWithContent(convertFromRaw(initialState)),
};
onChange = (editorState) => {
this.setState({
editorState,
});
};
focus = () => {
this.editor.focus();
};
render() {
return (
<div className={editorStyles.editor} onClick={this.focus}>
<Editor
editorState={this.state.editorState}
onChange={this.onChange}
plugins={plugins}
ref={(element) => {
this.editor = element;
}}
/>
</div>
);
}
}
import React from 'react';
const ColorBlock = React.forwardRef(
(
{
block, // eslint-disable-line no-unused-vars
blockProps, // eslint-disable-line no-unused-vars
customStyleMap, // eslint-disable-line no-unused-vars
customStyleFn, // eslint-disable-line no-unused-vars
decorator, // eslint-disable-line no-unused-vars
forceSelection, // eslint-disable-line no-unused-vars
offsetKey, // eslint-disable-line no-unused-vars
selection, // eslint-disable-line no-unused-vars
tree, // eslint-disable-line no-unused-vars
contentState, // eslint-disable-line no-unused-vars
blockStyleFn, // eslint-disable-line no-unused-vars
preventScroll, // eslint-disable-line no-unused-vars
style,
...elementProps
},
ref
) => (
<div
ref={ref}
{...elementProps}
style={{ width: 200, height: 80, backgroundColor: '#9bc0c7', ...style }}
/>
)
);
const createColorBlockPlugin = (config = {}) => {
const component = config.decorator
? config.decorator(ColorBlock)
: ColorBlock;
return {
blockRendererFn: (block, { getEditorState }) => {
if (block.getType() === 'atomic') {
const contentState = getEditorState().getCurrentContent();
const entity = contentState.getEntity(block.getEntityAt(0));
const type = entity.getType();
if (type === 'colorBlock') {
return {
component,
editable: false,
};
}
}
return null;
},
};
};
ColorBlock.displayName = 'ColorBlock';
export default createColorBlockPlugin;
.editor {
box-sizing: border-box;
border: 1px solid #ddd;
cursor: text;
padding: 16px;
border-radius: 2px;
margin-bottom: 2em;
box-shadow: inset 0px 1px 8px -3px #ABABAB;
background: #fefefe;
}
.editor :global(.public-DraftEditor-content) {
min-height: 140px;
}
.options {
margin-bottom: 20px;
}