Represents a {@link TextEditor text editor}'s {@link TextEditor.options options}.
Represents a {@link TextEditor text editor}'s {@link TextEditor.options options}.
(cursor-style text-editor-options)The rendering style of the cursor in this editor. When getting a text editor's options, this property will always be present. When setting a text editor's options, this property is optional.
Returns: TextEditorCursorStyle | undefined
The rendering style of the cursor in this editor. When getting a text editor's options, this property will always be present. When setting a text editor's options, this property is optional. **Returns:** `TextEditorCursorStyle | undefined`
(indent-size text-editor-options)The number of spaces to insert when {@link TextEditorOptions.insertSpaces insertSpaces} is true.
When getting a text editor's options, this property will always be a number (resolved).
When setting a text editor's options, this property is optional and it can be a number or "tabSize".
Returns: string | number | undefined
The number of spaces to insert when {@link TextEditorOptions.insertSpaces insertSpaces} is true.
When getting a text editor's options, this property will always be a number (resolved).
When setting a text editor's options, this property is optional and it can be a number or `"tabSize"`.
**Returns:** `string | number | undefined`(insert-spaces? text-editor-options)When pressing Tab insert {@link TextEditorOptions.tabSize n} spaces.
When getting a text editor's options, this property will always be a boolean (resolved).
When setting a text editor's options, this property is optional and it can be a boolean or "auto".
Returns: string | boolean | undefined
When pressing Tab insert {@link TextEditorOptions.tabSize n} spaces.
When getting a text editor's options, this property will always be a boolean (resolved).
When setting a text editor's options, this property is optional and it can be a boolean or `"auto"`.
**Returns:** `string | boolean | undefined`(line-numbers text-editor-options)Render relative line numbers w.r.t. the current line number. When getting a text editor's options, this property will always be present. When setting a text editor's options, this property is optional.
Returns: TextEditorLineNumbersStyle | undefined
Render relative line numbers w.r.t. the current line number. When getting a text editor's options, this property will always be present. When setting a text editor's options, this property is optional. **Returns:** `TextEditorLineNumbersStyle | undefined`
(set-cursor-style! text-editor-options value)The rendering style of the cursor in this editor. When getting a text editor's options, this property will always be present. When setting a text editor's options, this property is optional.
The rendering style of the cursor in this editor. When getting a text editor's options, this property will always be present. When setting a text editor's options, this property is optional.
(set-indent-size! text-editor-options value)The number of spaces to insert when {@link TextEditorOptions.insertSpaces insertSpaces} is true.
When getting a text editor's options, this property will always be a number (resolved).
When setting a text editor's options, this property is optional and it can be a number or "tabSize".
The number of spaces to insert when {@link TextEditorOptions.insertSpaces insertSpaces} is true.
When getting a text editor's options, this property will always be a number (resolved).
When setting a text editor's options, this property is optional and it can be a number or `"tabSize"`.(set-insert-spaces! text-editor-options value)When pressing Tab insert {@link TextEditorOptions.tabSize n} spaces.
When getting a text editor's options, this property will always be a boolean (resolved).
When setting a text editor's options, this property is optional and it can be a boolean or "auto".
When pressing Tab insert {@link TextEditorOptions.tabSize n} spaces.
When getting a text editor's options, this property will always be a boolean (resolved).
When setting a text editor's options, this property is optional and it can be a boolean or `"auto"`.(set-line-numbers! text-editor-options value)Render relative line numbers w.r.t. the current line number. When getting a text editor's options, this property will always be present. When setting a text editor's options, this property is optional.
Render relative line numbers w.r.t. the current line number. When getting a text editor's options, this property will always be present. When setting a text editor's options, this property is optional.
(set-tab-size! text-editor-options value)The size in spaces a tab takes. This is used for two purposes:
indentSize is set to "tabSize".When getting a text editor's options, this property will always be a number (resolved).
When setting a text editor's options, this property is optional and it can be a number or "auto".
The size in spaces a tab takes. This is used for two purposes:
- the rendering width of a tab character;
- the number of spaces to insert when {@link TextEditorOptions.insertSpaces insertSpaces} is true
and `indentSize` is set to `"tabSize"`.
When getting a text editor's options, this property will always be a number (resolved).
When setting a text editor's options, this property is optional and it can be a number or `"auto"`.(tab-size text-editor-options)The size in spaces a tab takes. This is used for two purposes:
indentSize is set to "tabSize".When getting a text editor's options, this property will always be a number (resolved).
When setting a text editor's options, this property is optional and it can be a number or "auto".
Returns: string | number | undefined
The size in spaces a tab takes. This is used for two purposes:
- the rendering width of a tab character;
- the number of spaces to insert when {@link TextEditorOptions.insertSpaces insertSpaces} is true
and `indentSize` is set to `"tabSize"`.
When getting a text editor's options, this property will always be a number (resolved).
When setting a text editor's options, this property is optional and it can be a number or `"auto"`.
**Returns:** `string | number | undefined`cljdoc builds & hosts documentation for Clojure/Script libraries
| Ctrl+k | Jump to recent docs |
| ← | Move to previous article |
| → | Move to next article |
| Ctrl+/ | Jump to the search field |