Skip to content

Autocompletion for the CodeMirror code editor

License

Notifications You must be signed in to change notification settings

codemirror/autocomplete

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

@codemirror/autocomplete NPM version

[ WEBSITE | DOCS | ISSUES | FORUM | CHANGELOG ]

This package implements autocompletion 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} from "@codemirror/view"
import {autocompletion} from "@codemirror/autocomplete"
import {jsonLanguage} from "@codemirror/lang-json"

const view = new EditorView({
  parent: document.body,
  extensions: [
    jsonLanguage,
    autocompletion(),
    jsonLanguage.data.of({
      autocomplete: ["id", "name", "address"]
    })
  ]
})

This configuration will just complete the given words anywhere in JSON context. Most language modules come with more refined autocompletion built-in, but you can also write your own custom autocompletion sources and associate them with your language this way.