UI kit reference

code/editor/LanguageEditor

import { … } from 'zidane-ui/code/editor'ui/src/code/editor/LanguageEditor.tsx

Components#

A CodeEditor wired to a language service; see the module comment.

TypeScript

function LanguageEditor(props: LanguageEditorProps): Element

Parameters
Name	Type	Description
props	`LanguageEditorProps`	See `LanguageEditorProps`.

Element

LanguageEditor props
Name	Type	Description
className?	`string`	Extra classes on the root element.
doc	`CodeDocument`	The file's state from `useCodeDocument`.
language	`EditorLanguage \| null`	The service for this file; `null`: a plain `CodeEditor` with no findings, hovers or navigation.
onDiagnostics?	`(path: string, items: readonly EditorDiagnostic[] \| null) => void`	The file's findings changed (`null`: a check runs).
onNavigate?	`(target: EditorLocation) => void`	Open a file at a position (a definition, a reference).
path	`string`	The file's path; the language service and navigation targets know it by this.
readOnly?	`boolean`	Never arm the editor.
reveal?	`EditorReveal \| null`	Where to go in this file, once per nonce.
sessionKey	`string`	pierre's retained-session key (the draft and undo stack survive remounts under it).
style?	`CSSProperties`	Inline styles on the root element, merged after the component's own.
visible	`boolean`	Whether this editor is on screen; focus and ⌘F follow it.

Edits are sent this long after the last keystroke, like the app's language servers.

TypeScript

const LANGUAGE_DEBOUNCE_MS = 300

TypeScript

interface LanguageEditorProps

LanguageEditorProps properties
Name	Type	Description
className?	`string`	Extra classes on the root element.
doc	`CodeDocument`	The file's state from `useCodeDocument`.
language	`EditorLanguage \| null`	The service for this file; `null`: a plain `CodeEditor` with no findings, hovers or navigation.
onDiagnostics?	`(path: string, items: readonly EditorDiagnostic[] \| null) => void`	The file's findings changed (`null`: a check runs).
onNavigate?	`(target: EditorLocation) => void`	Open a file at a position (a definition, a reference).
path	`string`	The file's path; the language service and navigation targets know it by this.
readOnly?	`boolean`	Never arm the editor.
reveal?	`EditorReveal \| null`	Where to go in this file, once per nonce.
sessionKey	`string`	pierre's retained-session key (the draft and undo stack survive remounts under it).
style?	`CSSProperties`	Inline styles on the root element, merged after the component's own.
visible	`boolean`	Whether this editor is on screen; focus and ⌘F follow it.