@planview/pv-editor
v1.0.0
Published
Implementation of Planview Design system rich text editor
Downloads
1,786
Readme
@planview/pv-editor
React implementation of Planview Design System Rich Text Editor
following the specification.
This package enables rich text editing in a unified way for Planview products. It is a wrapper around TipTap and ProseMirror.
Setup
You can install @planview/pv-editor
in multiple ways:
NPM
npm install @planview/pv-editor --save
Yarn
yarn add @planview/pv-editor
Usage
Due to the underlying technology being used, the Editor only runs in uncontrolled mode. To update the content after it has mounted, you can use the EditorApi exposed via the ref.
import { Editor } from '@planview/pv-editor'
const MyView = () => {
const [currentValue, setCurrentValue] = React.useState()
return (
<Editor
defaultValue="<p>Hello world!</p>"
onReady={(editor) => {
setCurrentValue(editor.getValue())
}}
onChange={(editor) => {
setCurrentValue(editor.getValue())
}}
/>
)
}