Skip to content

@jsvision/files / FileEditorOptions

Interface: FileEditorOptions

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

Construction options for FileEditor.

Extends

  • EditorOptions

Extended by

Properties

autoIndent?

optional autoIndent?: boolean

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

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

Inherited from

EditorOptions.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).


clipboard?

optional clipboard?: Editor

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

The shared clipboard editor. There is no implicit default: without one, in-app Cut/Copy/Paste between editors is a no-op. Pass the same Editor instance to every editor that should share a clipboard (typically a single hidden editor).

Inherited from

EditorOptions.clipboard


commands?

optional commands?: EditorCommandSeam

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

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

Inherited from

EditorOptions.commands


editorDialog?

optional editorDialog?: EditorDialogHandler

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

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

Inherited from

EditorOptions.editorDialog


fileName?

optional fileName?: string

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

The bound file path; omit for an untitled buffer.


fs

fs: FileSystem

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

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


keyBindings?

optional keyBindings?: EditorKeyBindings

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

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

Inherited from

EditorOptions.keyBindings


overwrite?

optional overwrite?: boolean

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

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

Inherited from

EditorOptions.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).


undoDepth?

optional undoDepth?: number

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

Maximum retained undo steps (default 1000).

Inherited from

EditorOptions.undoDepth