README.md

@codemirror/lang-vue

[ WEBSITE | ISSUES | FORUM | CHANGELOG ]

This package implements Vue template support for the CodeMirror code editor.

The project page has more information, a number of examples and the documentation.

This code is released under an MIT license.

We aim to be an inclusive, welcoming community. To make that explicit, we have a code of conduct that applies to communication around the project.

Usage

import {EditorView, basicSetup} from "codemirror"
import {vue} from "@codemirror/lang-vue"

const view = new EditorView({
  parent: document.body,
  doc: `<p>{{ message }}</p>`,
  extensions: [basicSetup, vue()]
})

API Reference

vue(config⁠?: Object = {}) → LanguageSupport

Vue template support.

config

base⁠?: LanguageSupport

Provide an HTML language configuration to use as a base. Must be the result of calling html() from @codemirror/lang-html, not just any LanguageSupport object.

vueLanguage: LRLanguage

A language provider for Vue templates.