vue-codemirror

       

CodeMirror(6) component for Vue(3).

vue-codemirror v5 has been released, a new version based on CodeMirorr@6 and only available for Vue3; since CodeMirorr@6 is developed with native ES Modules, the new version will no longer support direct browser references to UMD modules; in short, the new version is ⚠️ completely NOT compatible with that of previous version. If you wish to continue using Vue2 or a lower version of CodeMirorr, please follow the legacy versions below.

This example site contains most of what you want.

Legacy version

• examples (Vue2)
• vue-codemirror@4.0.0 (Vue2 / CodeMirror5)

---

Documentation

• CodeMirror6 Guide
• CodeMirror6 APIs
• CodeMirror6 Examples
• CodeMirror6 Example: Writing a Language Package
• CodeMirror6 Example: Styling
• CodeMirror Forum

CodeMirror packages

• CodeMirror6 Languages
• CodeMirror6 Themes

---

Usage

Install

yarn add vue-codemirror

npm install vue-codemirror --save

Depending on your actual needs, you may need to install more CodeMirror packages

# CodeMirror languages...
yarn @codemirror/lang-html
yarn @codemirror/lang-json
yarn @codemirror/lang-javascript

# CodeMirror themes...
yarn @codemirror/theme-one-dark

# more CodeMirror packages...

local component

<template>
  <codemirror
    v-model="code"
    placeholder="Code gose here..."
    :style="{ height: '400px' }"
    :autofocus="true"
    :indent-with-tab="true"
    :tabSize="2"
    :extensions="extensions"
    @ready="log('ready', $event)"
    @change="log('change', $event)"
    @focus="log('focus', $event)"
    @blur="log('blur', $event)"
  />
</template>

<script>
  import { Codemirror } from 'vue-codemirror'
  import { javascript } from '@codemirror/lang-javascript'
  import { oneDark } from '@codemirror/theme-one-dark'

  export default {
    components: {
      Codemirror
    },
    setup() {
      const code = ref(`console.log('Hello, world!')`)
      const extensions = [javascript(), oneDark]

      return {
        code,
        extensions,
        log: console.log
      }
    }
  }
</script>

global component

import { createApp } from 'vue'
import VueCodemirror from 'vue-codemirror'
import { basicSetup } from '@codemirror/basic-setup'

const app = createApp()

app.use(VueCodemirror, {
  // optional default global options
  autofocus: true,
  disabled: false,
  indentWithTab: true,
  tabSize: 2,
  placeholder: 'Code gose here...',
  extensions: [basicSetup]
  // ...
})

Component Props

prop	description	type	default
modelValue	The input values accepted by the component also support two-way binding.	String	''
autofocus	Focus editor immediately after mounted.	Boolean	false
disabled	Disable input behavior and disable change state.	Boolean	false
indentWithTab	Bind keyboard Tab key event.	Boolean	true
tabSize	Specify the indent when the Tab key is pressed.	Number	2
placeholder	Display when empty.	String	''
style	The CSS style object that acts on the CodeMirror itself.	Object	{}
extensions	Passed to CodeMirror EditorState.create({ extensions })	Extension	[]
selection	Passed to CodeMirror EditorState.create({ selection })	EditorSelection	-
root	Passed to CodeMirror new EditorView({ root })	ShadowRoot | Document	-

Component Events

event	description	params
update:modelValue	Only when the CodeMirror content (doc) has changed.	(value: string, viewUpdate: ViewUpdate)
change	ditto	ditto
update	When any state of CodeMirror changes.	(viewUpdate: ViewUpdate)
focus	When CodeMirror focused.	(viewUpdate: ViewUpdate)
blur	When CodeMirror blurred.	(viewUpdate: ViewUpdate)
ready	When edirot component mounted.	(payload: { view: EditorView; state: EditorState; container: HTMLDivElement })

Basic Setup

The basic-setup extension is integrated by default in the vue-codemirror configuration, and is intended as a handy helper to quickly set up CodeMirror without having to install and import a lot of standalone packages. If you want to override the default behavior of the config, just pass the empty array when installing the component globally.

app.use(VueCodemirror, {
  // keep the global default extensions empty
  extension: []
})

Changelog

Detailed changes for each release are documented in the release notes.

License

Licensed under the MIT License.