substance/editor/InsertNodeCommand.js

Substance is a JavaScript library for web-based content editing. It provides building blocks for realizing custom text editors and web-based publishing system. It is developed to power our online editing platform [Substance](http://substance.io).

import Command from './Command'

export default class InsertNodeCommand extends Command {
  constructor (config) {
    super(config)

    // Note: we want to know about the node which this command is producing
    // For example we will inhibit commands, that produce a node type
    // not allowed in the current position
    if (!this.config.nodeType) {
      console.error("'config.nodeType' should be provided for InsertNodeCommand")
    }
  }

  getType () {
    return this.config.nodeType
  }

  getCommandState (params, context) {
    const sel = params.selection
    const newState = {
      disabled: true,
      active: false
    }
    if (sel && !sel.isNull() && !sel.isCustomSelection() && sel.containerPath) {
      newState.disabled = false
    }
    newState.showInContext = this.showInContext(sel, params, context)
    return newState
  }

  showInContext (sel, params, context) {
    const editorSession = params.editorSession
    const selectionState = editorSession.getSelectionState()
    return sel.isCollapsed() && selectionState.isFirst && selectionState.isLast
  }

  isInsertCommand () {
    return true
  }

  execute (params, context) {
    var state = params.commandState
    if (state.disabled) return
    const editorSession = params.editorSession
    editorSession.transaction((tx) => {
      const nodeData = this.createNodeData(tx, params, context)
      const node = tx.insertBlockNode(nodeData)
      this.setSelection(tx, node)
    })
  }

  createNodeData (tx, params, context) {
    const type = params.type
    if (!type) throw new Error("'type' is mandatory")
    const editorSession = params.editorSession
    const doc = editorSession.getDocument()
    const nodeSchema = doc.getSchema().getNodeSchema(type)
    const nodeData = { type }
    for (const property of nodeSchema) {
      nodeData[property.name] = params[property.name]
    }
    return nodeData
  }

  setSelection (tx, node) {
    if (node.isText()) {
      tx.selection = {
        type: 'property',
        path: node.getPath(),
        startOffset: 0
      }
    }
  }
}