README.md

@tidbcloud/codemirror-extension-save-helper

A codemirror extension listens the editor doc changes, if changes, it will call the save handler in delay time, or, you can press the defined hotkey (default is Mod-s) to call save handler immediately.

Try it

• Full Featured Playground
• Simple Example

Installation

npm install @tidbcloud/codemirror-extension-save-helper

You need to install its peer dependencies as well:

npm install @codemirror/view @codemirror/state

Usage

import { EditorView } from '@codemirror/view'
import { EditorState } from '@codemirror/state'
import { saveHelper } from '@tidbcloud/codemirror-extension-save-helper'

const editorView = new EditorView({
  state: EditorState.create({
    doc,
    extensions: [
      saveHelper({
        save: (view: EditorView) => {
          // call save file api
          saveFile(view.state.doc.toString())
        }
      })
    ]
  })
})

API

type SaveHelperOptions = {
  /* in milliseconds, default 5000 */
  delay?: number
  /* default is true */
  auto?: boolean
  /* default is Mod-s */
  hotkey?: string
  /* save handler */
  save: (view: EditorView) => void
}

function saveHelper(options: SaveHelperOptions): Extension