npm.io
0.2.2 • Published 8 years ago

draft-js-modifiers

Licence
MIT
Version
0.2.2
Deps
2
Size
32 kB
Vulns
1
Weekly
0
Stars
8

draft-js-modifiers

CircleCI Coverage Status npm version License

Modular state modifiers for Draft.js

yarn add draft-js-modifiers

# or

npm i draft-js-modifiers

Usage

import * as Modifiers from 'draft-js-modifiers'

const newEditorState = Modifiers.mergeBlockData(currentEditorState, { foo: 1 })

Moduler importing

import adjustBlockDepth from 'draft-js-modifiers/adjustBlockDepth'

// Support Tree Shaking for webpack, rollup.js
import { insertText } from 'draft-js-modifiers'

Methods

adjustBlockDepth
adjustBlockDepth(editorState: EditorState, adjustment: number, maxDepth: number)
insertAtomicBlock
insertAtomicBlock(
  editorState: EditorState,
  entityType: string,
  mutability: 'IMMUTABLE' | 'MUTABLE' | 'SEGMENTED',
  data?: { [id: string]: any },
  character?: ?string = ' '
)
insertEmptyBlock
insertEmptyBlock(editorState: EditorState, blockType?: DraftBlockType = 'unstyled')
insertNewBlock
insertNewBlock(
  editorState: EditorState,
  blockType?: DraftBlockType = 'unstyled',
  text?: string = '',
  data?: { [id: string]: any } = {}
)
insertText
insertText(editorState: EditorState, text: string, entity?: ?string = null)
mergeBlockData
mergeBlockData(editorState: EditorState, data: { [id: string]: any })
mergeBlockDataByKey
mergeBlockDataByKey(editorState: EditorState, blockKey: string, data: { [id: string]: any })
mergeEntityData
mergeEntityData(editorState: EditorState, entityKey: string, data: { [id: string]: any })
modifyBlock
modifyBlock(editorState: EditorState, blockData: ContentBlock)
modifyBlockByKey
modifyBlockByKey(editorState: EditorState, blockKey: string, blockData: ContentBlock)
removeBlockStyle
removeBlockStyle(editorState: EditorState)
removeInlineStyles
removeInlineStyles(editorState: EditorState, inlineStyles: Array<string> = [])
resetBlock
resetBlock(editorState: EditorState, block: ContentBlock)
toggleBlockType
toggleBlockType(editorState: EditorState, blockType: string)
toggleEntity
toggleEntity(editorState: EditorState, entityKey: ?string)
toggleInlineStyle
toggleInlineStyle(editorState: EditorState, inlineStyle: string)

How to add module

yarn run add -- moduleName

# or

npm run add -- moduleName

License

MIT

sugarshin