remirror/remirror

View on GitHub
packages/remirror__extension-codemirror5/src/codemirror-types.ts

Summary

Maintainability
A
0 mins
Test Coverage
F
0%
import type CodeMirror from 'codemirror';
import type { ProsemirrorAttributes, Static } from '@remirror/core';

export interface CodeMirrorExtensionOptions {
  /**
   * Configuration for the inner CodeMirror editor.
   *
   * @defaultValue undefined
   */
  defaultCodeMirrorConfig?: CodeMirror.EditorConfiguration | null;

  /**
   * The instance of codemirror to use.
   */
  CodeMirror?: Static<typeof CodeMirror>;
}

export interface CodeMirrorExtensionAttributes extends ProsemirrorAttributes {
  /**
   * Configuration for the inner CodeMirror editor.
   *
   * @defaultValue undefined
   */
  codeMirrorConfig?: CodeMirror.EditorConfiguration;

  /**
   * A string to represent the language, which will be passed into CodeMirror's
   * `findModeByName` function. Note that you can also specify the
   * language by editing `codeMirrorConfig.mode` directly.
   *
   * @defaultValue undefined
   */
  language?: string;
}