Editor

A retained native code editor with syntax coloring, line numbers, indentation, and both-axis scrolling.

No language grammars are included by default. Register a linked grammar in Rust, or load one portable pack of selected Tree-sitter Wasm grammars and queries using loadLanguagePack (TypeScript) / LoadLanguagePack (Go).

Unstyled by default: text and line-number colors inherit, and the component adds no background, border, rounding, padding, or syntax/diff palette. Supply application styles and explicit colors to opt into an appearance.

#Import

go get github.com/egoist/quickgui/extensions/editor

import (
	"github.com/egoist/quickgui/extensions/editor"
	"github.com/egoist/quickgui/go/ui"
)

#Usage

func EditorExample() *ui.Element {
	source, setSource := ui.CreateSignal("package main\n\nfunc main() {}\n")
	return editor.Editor(editor.EditorProps{
		Value:       source,
		Language:    "go",
		LineNumbers: true,
		TabSize:     4,
		OnChange:    setSource,
		Props:       ui.Props{Style: ui.Style().Width("100%").Height(360)},
	})
}

#Syntax highlighting

Language selects a registered Tree-sitter grammar and highlight query. Query captures map through SyntaxTheme to eight foreground-only paint classes, so color never changes text metrics. Source or language changes reparse the bounded document; palette changes only remap retained captures, and scrolling does no syntax work. Parsing is limited to 2 MiB, individual lines over 32 KiB stay plain, and the capture count is capped. This does not require a language server.

#API reference

Expand an entry for its description and complete signature. A dash means no declaration default is documented.

`editor.Editor`

editor.Editor(props EditorProps) *ui.Element

StyleStyleBuilder—

Reusable layout, typography, color, and interaction-state styles. Build with ui.Style() and compose with Merge.

StyleBuilder

Childrenany—

Content mounted inside the component. Compound child callbacks run after the parent context exists.

any

OnClickfunc(*native.Event)—

Called after QuickGUI resolves an activation, including supported keyboard activation.

func(*native.Event)

OnMouseEnterfunc(*native.Event)—

Callback for mouse enter. The signature below lists the event payload.

func(*native.Event)

OnMouseLeavefunc(*native.Event)—

Callback for mouse leave. The signature below lists the event payload.

func(*native.Event)

OnInputfunc(*native.Event)—

Receives edits from the text control. Write the new text into the controlled value.

func(*native.Event)

OnSubmitfunc(*native.Event)—

Called when the control submits its current value.

func(*native.Event)

OnDismissfunc(*native.Event)—

Reports toast identifiers dismissed by the core.

func(*native.Event)

OnPointerfunc(*native.Event)—

Callback for pointer. The signature below lists the event payload.

func(*native.Event)

OnPresentationChangefunc(*native.Event)—

Callback for presentation change. The signature below lists the event payload.

func(*native.Event)

OnSelectfunc(*native.Event)—

Reports the menu entry selected by the core.

func(*native.Event)

OnKeyDownfunc(*native.Event)—

Callback for key down. The signature below lists the event payload.

func(*native.Event)

OnKeyUpfunc(*native.Event)—

Callback for key up. The signature below lists the event payload.

func(*native.Event)

OnMouseDownfunc(*native.Event)—

Callback for mouse down. The signature below lists the event payload.

func(*native.Event)

OnMouseUpfunc(*native.Event)—

Callback for mouse up. The signature below lists the event payload.

func(*native.Event)

OnMouseMovefunc(*native.Event)—

Callback for mouse move. The signature below lists the event payload.

func(*native.Event)

OnDoubleClickfunc(*native.Event)—

Callback for double click. The signature below lists the event payload.

func(*native.Event)

OnWheelfunc(*native.Event)—

Callback for wheel. The signature below lists the event payload.

func(*native.Event)

OnContextMenufunc(*native.Event)—

Callback for context menu. The signature below lists the event payload.

func(*native.Event)

OnPinchfunc(*native.Event)—

Callback for pinch. The signature below lists the event payload.

func(*native.Event)

OnRotatefunc(*native.Event)—

Callback for rotate. The signature below lists the event payload.

func(*native.Event)

OnSmartMagnifyfunc(*native.Event)—

Callback for smart magnify. The signature below lists the event payload.

func(*native.Event)

OnPressurefunc(*native.Event)—

Callback for pressure. The signature below lists the event payload.

func(*native.Event)

OnFocusfunc(*native.Event)—

Callback for focus. The signature below lists the event payload.

func(*native.Event)

OnBlurfunc(*native.Event)—

Callback for blur. The signature below lists the event payload.

func(*native.Event)

OnActionfunc(*native.Event)—

Callback for action. The signature below lists the event payload.

func(*native.Event)

OnDragStartfunc(*native.Event)—

Callback for drag start. The signature below lists the event payload.

func(*native.Event)

OnDragEndfunc(*native.Event)—

Callback for drag end. The signature below lists the event payload.

func(*native.Event)

OnDropfunc(*native.Event)—

Callback for drop. The signature below lists the event payload.

func(*native.Event)

OnFilesDroppedfunc(*native.Event)—

Callback for files dropped. The signature below lists the event payload.

func(*native.Event)

OnComponentChangefunc(*native.Event)—

Receives the component change payload, including values for coordinated controls.

func(*native.Event)

OnCommitfunc(*native.Event)—

Reports one explicit commit boundary and its final value details.

func(*native.Event)

Disabledany—

Prevents activation and exposes the disabled state to accessibility. Compound parts inherit a disabled root.

any

Valueany—

The current controlled value. Update application state from the change callback to accept a new value.

any

Placeholderstring—

Hint displayed while the text value is empty.

string

Multilinebool—

Allows multiple lines in the core text editor.

bool

AriaLabelany—

Accessible name, especially for icon-only controls or controls without a visible label.

any

Selectedany—

Exposes the selected state of this item.

any

Groupany—

Names this element as a group for descendant interaction-state styling.

any

FocusOnPointerany—

Whether a pointer press moves keyboard focus to the control.

any

FocusableWhenDisabledany—

Allows a disabled button to remain keyboard focusable while activation stays disabled.

any

HitSlopany—

Expands the pointer hit area without changing the visual bounds.

any

HitSlopTopany—

Extra pointer hit area above the visual bounds.

any

HitSlopRightany—

Extra pointer hit area to the right of the visual bounds.

any

HitSlopBottomany—

Extra pointer hit area below the visual bounds.

any

HitSlopLeftany—

Extra pointer hit area to the left of the visual bounds.

any

Reffunc(*native.Node)—

Receives the retained native node after construction. Keep imperative work in event or lifecycle callbacks.

func(*native.Node)

Passwordany—

Conceals the entered text while preserving the editor’s value.

any

EstimatedItemHeightany—

Initial logical row-height estimate used by virtualization.

any

Overscanany—

Extra rows mounted before and after the visible range.

any

OverscanPixelsany—

Extra logical distance mounted before and after the visible range.

any

ItemHeightsany—

Exact row heights supplied without waiting for layout measurement.

any

ListAlignmentstring—

Pins short list content to the top or bottom.

string

FollowModestring—

Chooses ordinary scrolling or tail-following behavior.

string

ObjectFitstring—

How image content fits its declared box.

string

ShaderParametersany—

Up to sixteen numeric values packed into fixed shader parameter vectors.

any

Invalidany—

Projects invalid state to the field and its parts.

any

Roleany—

Accessibility role override. Prefer the component’s built-in semantics.

any

TabIndexany—

Controls sequential keyboard focus order. Omit to retain the component’s default focus behavior.

any

Overlayany—

Places this content in the overlay paint plane.

any

FocusTrapany—

Keeps keyboard focus within the active modal surface.

any

RestorePreviousFocusany—

Restores the previously focused element when the surface closes.

any

AutoFocusany—

Requests initial keyboard focus when the element mounts.

any

AriaModalany—

Exposes the modal state of the surface to accessibility.

any

DismissOnEscapeany—

Allows Escape to dismiss the surface.

any

DismissOnPointerOutsideany—

Allows a pointer press outside the surface to dismiss it.

any

TooltipTextany—

Text displayed by the element’s tooltip.

any

TooltipPlacementany—

Preferred side and alignment of the tooltip.

any

TooltipDelayany—

Delay before the tooltip opens.

any

TooltipGapany—

Space between the tooltip and its trigger.

any

TooltipViewportMarginany—

Minimum space between the tooltip and the window edges.

any

AnchorTargetany—

Identity of the element used to position the surface.

any

AnchorPlacementany—

Preferred side and alignment relative to the anchor.

any

AnchorGapany—

Space between the anchor and its surface, in logical pixels.

any

ViewportMarginany—

Minimum space reserved around the surface within the viewport.

any

Keymapany—

Keyboard bindings used by the editor.

any

Draggableany—

Enables the element as a drag source.

any

DropKindsany—

Kinds of drop payload this target accepts.

any

Languageany—

Configures language for this part. The declared type and source define the accepted value.

any

LineNumbersany—

Configures line numbers for this part. The declared type and source define the accepted value.

any

TabSizeany—

Configures tab size for this part. The declared type and source define the accepted value.

any

InsertSpacesany—

Inserts spaces instead of a tab character.

any

AutoIndentany—

Configures auto indent for this part. The declared type and source define the accepted value.

any

ReadOnlyany—

Preserves the current value while keeping the control available for focus and inspection.

any

ContentPaddingContentPadding—

Configures content padding for this part. The declared type and source define the accepted value.

ContentPadding

GutterPaddingGutterPadding—

Configures gutter padding for this part. The declared type and source define the accepted value.

GutterPadding

GutterBackgroundany—

Overrides the line-number gutter background.

any

GutterColorany—

Configures gutter color for this part. The declared type and source define the accepted value.

any

ActiveLineBackgroundany—

Configures active line background for this part. The declared type and source define the accepted value.

any

ActiveLineNumberColorany—

Configures active line number color for this part. The declared type and source define the accepted value.

any

SyntaxThemeSyntaxTheme—

Configures syntax theme for this part. The declared type and source define the accepted value.

SyntaxTheme

OnChangefunc(string)—

Callback for change. The signature below lists the event payload.

func(string)