JSVision

Appearance

@jsvision/files / OpenFileInEditorOptions

Interface: OpenFileInEditorOptions ​

Defined in: files/src/editor/open-file.ts:15

Options for openFileInEditor — every FileEditorOptions field, plus an initial rect.

Extends ​

Properties ​

autoIndent? ​

optional autoIndent?: boolean

Defined in: ui/dist/editor/editor-types.d.ts:38

Copy the previous line's leading whitespace when pressing Enter (default false).

Inherited from ​

FileEditorOptions.autoIndent

backupFiles? ​

optional backupFiles?: boolean

Defined in: files/src/editor/file-editor.ts:30

Keep a .bak of the previous content on each save (default true).

Inherited from ​

FileEditorOptions.backupFiles

clipboard? ​

optional clipboard?: Editor

Defined in: ui/dist/editor/editor-types.d.ts:32

An optional editor that exposes clipboard contents.

The application event loop owns the canonical clipboard, so ordinary in-app Cut/Copy/Paste works without this option. Pass the same Editor instance when an application needs a visible projection, as in the editor demonstration. Editing the projection does not replace the canonical value until the edited text is explicitly copied.

Inherited from ​

FileEditorOptions.clipboard

commands? ​

optional commands?: EditorCommandSeam

Defined in: ui/dist/editor/editor-types.d.ts:42

Hook for greying out editing commands as selection/undo state changes (default: none).

Inherited from ​

FileEditorOptions.commands

editorDialog? ​

optional editorDialog?: EditorDialogHandler

Defined in: ui/dist/editor/editor-types.d.ts:34

Handler for find/replace/save prompts. Defaults to a handler that cancels every prompt.

Inherited from ​

FileEditorOptions.editorDialog

fileName? ​

optional fileName?: string

Defined in: files/src/editor/file-editor.ts:28

The bound file path; omit for an untitled buffer.

Inherited from ​

FileEditorOptions.fileName

fs ​

fs: FileSystem

Defined in: files/src/editor/file-editor.ts:26

The filesystem to read and write through (the only path to disk).

Inherited from ​

FileEditorOptions.fs

keyBindings? ​

optional keyBindings?: EditorKeyBindings

Defined in: ui/dist/editor/editor-types.d.ts:44

Editor key set — 'modern' (default) overlays Ctrl+X/C/V/A; 'wordstar' = the classic WordStar layout.

Inherited from ​

FileEditorOptions.keyBindings

overwrite? ​

optional overwrite?: boolean

Defined in: ui/dist/editor/editor-types.d.ts:40

Start in overwrite mode; Insert toggles it (default false = insert mode).

Inherited from ​

FileEditorOptions.overwrite

promptOnReplace? ​

optional promptOnReplace?: boolean

Defined in: files/src/editor/file-editor.ts:32

Prompt before overwriting during the editor's replace flow (default true).

Inherited from ​

FileEditorOptions.promptOnReplace

rect? ​

optional rect?: Rect

Defined in: files/src/editor/open-file.ts:17

The window's initial rectangle, applied before it is mounted.

undoDepth? ​

optional undoDepth?: number

Defined in: ui/dist/editor/editor-types.d.ts:36

Maximum retained undo steps (default 1000).

Inherited from ​

FileEditorOptions.undoDepth