Class EditorLanguageRegistry

CodeMirror language registry

Hierarchy

EditorLanguageRegistry

Implements

IEditorLanguageRegistry

Index

Constructors

Properties

Methods

addLanguage findBest findByExtension findByFileName findByMIME findByName getLanguage getLanguages highlight makeSpec

Constructors

constructor

new EditorLanguageRegistry(): EditorLanguageRegistry
Returns EditorLanguageRegistry
- Defined in packages/codemirror/lib/language.d.ts:9

Properties

`Private` _modeList

_modeList: any

Methods

addLanguage

addLanguage(language): void
Register a new language for CodeMirror
Parameters
- language: IEditorLanguage
  
  Language to register
Returns void
Implementation of IEditorLanguageRegistry.addLanguage
- Defined in packages/codemirror/lib/language.d.ts:15

findBest

findBest(language, fallback?): IEditorLanguage
Find a codemirror mode by name or CodeMirror spec.
Parameters
- language: string | IEditorLanguage
  
  The CodeMirror mode
- Optional fallback: boolean
  
  Whether to fallback to default mimetype spec or not
Returns IEditorLanguage
The mode or null
Implementation of IEditorLanguageRegistry.findBest
- Defined in packages/codemirror/lib/language.d.ts:67

findByExtension

findByExtension(ext): IEditorLanguage
Find a codemirror mode by extension.
Parameters
- ext: string | readonly string[]
  
  The extension name
Returns IEditorLanguage
The mode or null
Implementation of IEditorLanguageRegistry.findByExtension
- Defined in packages/codemirror/lib/language.d.ts:52

findByFileName

findByFileName(name): IEditorLanguage
Find a codemirror mode by filename.
Parameters
- name: string
  
  File name
Returns IEditorLanguage
The mode or null
Implementation of IEditorLanguageRegistry.findByFileName
- Defined in packages/codemirror/lib/language.d.ts:59

findByMIME

findByMIME(mime, strict?): IEditorLanguage
Find a codemirror mode by MIME.
Parameters
- mime: string | readonly string[]
  
  Mime type to look for
- Optional strict: boolean
  
  Whether xml and json should be assimilated to the generic mimetype
Returns IEditorLanguage
The mode or null
Implementation of IEditorLanguageRegistry.findByMIME
- Defined in packages/codemirror/lib/language.d.ts:38

findByName

findByName(name): IEditorLanguage
Find a codemirror mode by name.
Parameters
- name: string
  
  The mode name
Returns IEditorLanguage
The mode or null
Implementation of IEditorLanguageRegistry.findByName
- Defined in packages/codemirror/lib/language.d.ts:45

getLanguage

getLanguage(language): Promise<IEditorLanguage>
Ensure a codemirror mode is available by name or Codemirror spec.
Parameters
- language: string | IEditorLanguage
  
  The mode to ensure. If it is a string, uses [findBest] to get the appropriate spec.
Returns Promise<IEditorLanguage>
A promise that resolves when the mode is available.
Implementation of IEditorLanguageRegistry.getLanguage
- Defined in packages/codemirror/lib/language.d.ts:24

getLanguages

getLanguages(): IEditorLanguage[]
Get the raw list of available modes specs.

Returns IEditorLanguage[]
The available modes
Implementation of IEditorLanguageRegistry.getLanguages
- Defined in packages/codemirror/lib/language.d.ts:30

highlight

highlight(code, language, el): Promise<void>
Parse and style a string.
Parameters
- code: string
  
  Code to highlight
- language: IEditorLanguage
  
  Code language
- el: HTMLElement
  
  HTML element into which the highlighted code will be inserted
Returns Promise<void>
Implementation of IEditorLanguageRegistry.highlight
- Defined in packages/codemirror/lib/language.d.ts:75

`Protected` makeSpec

makeSpec(spec): IEditorLanguage
Parameters
- spec: IEditorLanguage
Returns IEditorLanguage
- Defined in packages/codemirror/lib/language.d.ts:76

Generated using TypeDoc