Settings

Access and manage editor settings

Extensions can read and update Klyx’s editor settings through the Settings service. Editor settings control Klyx’s built-in editor behavior and are reactive — changes are reflected in real time.

Settings service

Access the settings service with:

private val settings: Settings by plugin()

Observing settings

// Collect all settings as they change
settings.settings.collect { appSettings ->
    val fontSize = appSettings.editor.fontSize
    val darkMode = appSettings.appearance.theme
}

Updating editor settings

// Update a single editor setting
settings.updateEditorSettings { editor ->
    editor.copy(fontSize = 16f, wordWrap = true)
}

// Update appearance settings
settings.updateAppearanceSettings { appearance ->
    appearance.copy(theme = AppTheme.Dark)
}

// Update terminal settings
settings.updateTerminalSettings { terminal ->
    terminal.copy(fontSize = 14f)
}

// Update file tree settings
settings.updateFileTreeSettings { fileTree ->
    fileTree.copy(showHiddenFiles = true)
}

// Update all settings at once
settings.updateSettings { allSettings ->
    allSettings.copy(
        appearance = allSettings.appearance.copy(theme = AppTheme.Light),
        editor = allSettings.editor.copy(fontSize = 18f)
    )
}

Convenience extensions

// Set the application theme
settings.setTheme(AppTheme.Dark)

// Toggle dark mode
settings.setDarkMode(true)

EditorSettings

The EditorSettings data class controls the code editor’s behavior. All fields have sensible defaults.

Available settings

Setting	Type	Default	Description
fontSize	Float	14f	Font size in sp for editor text
pinLineNumbers	Boolean	false	Keep line numbers visible when scrolling horizontally
wordWrap	Boolean	false	Wrap long lines to the next visual row
tabSize	Int	4	Number of spaces for a tab character
customFontUri	String?	null	URI to a custom font file
deleteEmptyLineFast	Boolean	true	Instantly delete entire whitespace-only lines
deleteMultiSpaces	Int	1	Number of leading spaces to delete at once with backspace
symbolPairAutoCompletion	Boolean	true	Automatically insert closing brackets and quotes
autoIndent	Boolean	true	Apply indentation to new lines
disallowSuggestions	Boolean	false	Force the IME to hide autocorrect suggestions
indicatorWaveLength	Float	18f	Length of the error/warning indicator wave
indicatorWaveWidth	Float	0.9f	Width of the error/warning indicator wave
indicatorWaveAmplitude	Float	4f	Amplitude of the error/warning indicator wave
useICULibToSelectWords	Boolean	true	Use ICU library for word boundary calculation
highlightMatchingDelimiters	Boolean	true	Highlight corresponding opening/closing brackets
boldMatchingDelimiters	Boolean	true	Apply bold styling to matching brackets
enableRoundTextBackground	Boolean	true	Use rounded edges for text background highlights
formatPastedText	Boolean	false	Format code blocks when pasted
enhancedHomeAndEnd	Boolean	true	Jump to first non-whitespace before line start
reselectOnLongPress	Boolean	true	Select new words under finger even if text is highlighted
fastScrollSensitivity	Float	5f	Sensitivity factor for fast scrolling
mouseWheelScrollFactor	Float	1.2f	Factor applied to mouse wheel scroll events
mouseMode	MouseMode	MouseMode.Auto	Behavior when a mouse is used
mouseModeAlwaysShowScrollbars	Boolean	true	Keep scrollbars visible in mouse mode
mouseContextMenu	Boolean	true	Show native right-click context menus
stickyScroll	Boolean	false	Pin scope headers to the top while scrolling
stickyScrollMaxLines	Int	3	Maximum lines pinned in sticky scroll
stickyScrollPreferInnerScope	Boolean	false	Show nested inner scopes when max lines exceeded
stickyScrollAutoCollapse	Boolean	true	Hide sticky lines when selecting text behind them
selectCompletionItemOnEnterForSoftKbd	Boolean	true	Accept autocomplete on enter for soft keyboards
inlayHints	Boolean	true	Show inlay hints

deleteMultiSpaces

This setting controls how many spaces are deleted when pressing backspace. It is typed as Int rather than Boolean:

settings.updateEditorSettings { editor ->
    // Delete 1 space at a time (classic behavior)
    editor.copy(deleteMultiSpaces = 1)

    // Delete up to 4 spaces at once (smart deletion)
    editor.copy(deleteMultiSpaces = 4)
}

Setting it to 0 disables multi-space deletion entirely.

MouseMode

The editor’s mouse behavior enum:

Value	Description
MouseMode.Auto	Automatically enable mouse mode when a mouse hover is detected
MouseMode.Always	Always show mouse handles and optimized UI
MouseMode.Never	Never use mouse-optimized UI elements

AppTheme

The application theme enum:

Value	Description
AppTheme.System	Follow the system-wide light/dark preference
AppTheme.Dark	Force dark theme
AppTheme.Light	Force light theme

Example

Observe editor font size changes and update them:

override suspend fun onStart() {
    // Observe settings
    settings.settings.collect { appSettings ->
        val fontSize = appSettings.editor.fontSize
        // React to changes
    }

    // Update a setting
    settings.updateEditorSettings { editor ->
        editor.copy(fontSize = 16f)
    }
}