Skip to content

Latest commit

 

History

History
34 lines (21 loc) · 1.4 KB

README.md

File metadata and controls

34 lines (21 loc) · 1.4 KB
Raw

React Codemirror

This package can be built with npm run build and then published to npm with npm publish.

Usage

npm install @neo4j-cypher/react-codemirror@next

import { useState } from 'react';

import { CypherEditor } from '@neo4j-cypher/react-codemirror@next';

export function CodeEditor() {
  const [value, setValue] = useState('');
  // can be used to access underlying codemirror state or call for example `focus`
  const editorRef = useRef<CypherEditor>(null);

  return <CypherEditor value={value} onChange={setValue} ref={editorRef} />;
}

For a full example, see the react-codemirror-playground.

Usage without react

Currently we only support using the codemirror editor via the react wrapper, but we plan to release the codemirror extensions separately as well.

Learning codemirror

It can take a little time to get into the CodeMirror6 ways of thinking, Trevor Harmon has a great blog post explaining the cm6 "primitives". He also has a demo on how to integrate ANTLR4 with codemirror over here.

Completion Icons

We use unmodified copies of Visual Studio Code Icons from microsofts repository here licensed under creative commons.