@jsvision/files / FileEditorOptions
Interface: FileEditorOptions
Defined in: files/src/editor/file-editor.ts:24
Construction options for FileEditor.
Extends
EditorOptions
Extended by
Properties
autoIndent?
optionalautoIndent?: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
EditorOptions.autoIndent
backupFiles?
optionalbackupFiles?:boolean
Defined in: files/src/editor/file-editor.ts:30
Keep a .bak of the previous content on each save (default true).
clipboard?
optionalclipboard?: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
EditorOptions.clipboard
commands?
optionalcommands?: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
EditorOptions.commands
editorDialog?
optionaleditorDialog?: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
EditorOptions.editorDialog
fileName?
optionalfileName?: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?
optionalkeyBindings?: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
EditorOptions.keyBindings
overwrite?
optionaloverwrite?:boolean
Defined in: ui/dist/editor/editor-types.d.ts:40
Start in overwrite mode; Insert toggles it (default false = insert mode).
Inherited from
EditorOptions.overwrite
promptOnReplace?
optionalpromptOnReplace?:boolean
Defined in: files/src/editor/file-editor.ts:32
Prompt before overwriting during the editor's replace flow (default true).
undoDepth?
optionalundoDepth?:number
Defined in: ui/dist/editor/editor-types.d.ts:36
Maximum retained undo steps (default 1000).
Inherited from
EditorOptions.undoDepth