Toolbar

Add custom toolbar actions to Klyx

Extensions can add actions to Klyx’s toolbar. Each action has an ID, label, icon, category, priority, and click handler. Registration uses Kotlin context receivers — you do not pass the plugin instance explicitly.

ToolbarRegistry

Register toolbar actions during onLoad() or onStart().

private val toolbar: ToolbarRegistry by plugin()

// Inside a KlyxPlugin method:
toolbar.register(ToolbarAction(
    id = "myext.action",
    label = "My Action",
    icon = ToolbarIcon.ImageVector(Icons.Default.Star),
    category = ToolbarCategory("My Plugin"),
    priority = 100,
    onClick = { /* handle action */ }
))

Unregister an action

toolbar.unregister("myext.action")

List all actions

val allActions: List<ToolbarAction> = toolbar.actions()

ToolbarAction fields

Field	Type	Default	Description
id	String	required	Unique action identifier (reverse-DNS recommended)
label	String	required	Display text
icon	ToolbarIcon?	null	Optional icon
category	ToolbarCategory	ToolbarCategory.Plugins	Grouping category
priority	Int	0	Sort order (higher appears first within the category)
onClick	() -> Unit	required	Click handler

ToolbarIcon

A sealed interface with four source types:

Type	Constructor	Description
Resource	ToolbarIcon.Resource(path)	Icon bundled inside the plugin (e.g. "icons/git.svg")
File	ToolbarIcon.File(file)	Load from a file on disk
Painter	ToolbarIcon.Painter(painter)	A Compose Painter instance
ImageVector	ToolbarIcon.ImageVector(imageVector)	A Compose ImageVector

Convenience extension functions are also available:

val icon1: ToolbarIcon = ToolbarIcon(Icons.Default.Star)       // ImageVector
val icon2: ToolbarIcon = ToolbarIcon(myPainter)                  // Painter

ToolbarCategory

Pre-defined categories in the companion object:

Category	Description
ToolbarCategory.CurrentFile	Operations on the currently open file
ToolbarCategory.Workspace	Workspace-level operations
ToolbarCategory.Run	Run and execute actions
ToolbarCategory.Tools	Tool actions
ToolbarCategory.Plugins	Plugin actions (default)

Custom categories are also supported:

ToolbarCategory("My Plugin")

ToolbarRegistration

The register method returns a ToolbarRegistration handle with an unregister() method:

val registration: ToolbarRegistration = toolbar.register(action)
// Later:
registration.unregister()

Or unregister by ID directly:

toolbar.unregister("myext.action")

Example

Register multiple actions with different categories and priorities:

override suspend fun onLoad() {
    toolbar.register(ToolbarAction(
        id = "myext.show_main",
        label = "My Extension",
        icon = ToolbarIcon.ImageVector(Icons.Default.Star),
        category = ToolbarCategory("My Plugin"),
        priority = 100,
        onClick = { navigator.navigateTo(NavDestination.Custom(ScreenId("myext.main"))) }
    ))

    toolbar.register(ToolbarAction(
        id = "myext.settings",
        label = "Settings",
        icon = ToolbarIcon.ImageVector(Icons.Default.Settings),
        category = ToolbarCategory.Tools,
        priority = 50,
        onClick = { navigator.navigateTo(NavDestination.Settings) }
    ))
}

override suspend fun onUnload() {
    toolbar.unregister("myext.show_main")
    toolbar.unregister("myext.settings")
}