0.12.2 • Published 1 year ago
@paiondata/lexical-react v0.12.2
@paiondata/lexical-react
This package provides a set of components and hooks for Lexical that allow for text editing in React applications.
Getting started
Install lexical
and @paiondata/lexical-react
:
npm install --save lexical @paiondata/lexical-react
Below is an example of a basic plain text editor using lexical
and @paiondata/lexical-react
(try it yourself).
import {$getRoot, $getSelection} from 'lexical';
import {useEffect} from 'react';
import {LexicalComposer} from '@paiondata/lexical-react/LexicalComposer';
import {PlainTextPlugin} from '@paiondata/lexical-react/LexicalPlainTextPlugin';
import {ContentEditable} from '@paiondata/lexical-react/LexicalContentEditable';
import {HistoryPlugin} from '@paiondata/lexical-react/LexicalHistoryPlugin';
import {OnChangePlugin} from '@paiondata/lexical-react/LexicalOnChangePlugin';
import {useLexicalComposerContext} from '@paiondata/lexical-react/LexicalComposerContext';
const theme = {
// Theme styling goes here
...
}
// When the editor changes, you can get notified via the
// LexicalOnChangePlugin!
function onChange(editorState) {
editorState.read(() => {
// Read the contents of the EditorState here.
const root = $getRoot();
const selection = $getSelection();
console.log(root, selection);
});
}
// Lexical React plugins are React components, which makes them
// highly composable. Furthermore, you can lazy load plugins if
// desired, so you don't pay the cost for plugins until you
// actually use them.
function MyCustomAutoFocusPlugin() {
const [editor] = useLexicalComposerContext();
useEffect(() => {
// Focus the editor when the effect fires!
editor.focus();
}, [editor]);
return null;
}
// Catch any errors that occur during Lexical updates and log them
// or throw them as needed. If you don't throw them, Lexical will
// try to recover gracefully without losing user data.
function onError(error) {
throw error;
}
function Editor() {
const initialConfig = {
namespace: 'MyEditor',
theme,
onError,
};
return (
<LexicalComposer initialConfig={initialConfig}>
<PlainTextPlugin
contentEditable={<ContentEditable />}
placeholder={<div>Enter some text...</div>}
/>
<OnChangePlugin onChange={onChange} />
<HistoryPlugin />
<MyCustomAutoFocusPlugin />
</LexicalComposer>
);
}