Enum WidgetAction 

pub enum WidgetAction {
    FocusAdvance {
        delta: i32,
    },
    Activate,
    SelectMove {
        delta: i32,
    },
    TextInputKey {
        key: String,
    },
    TextInputChar {
        text: String,
    },
    Key {
        key: String,
    },
}

Action a plugin can request the widget runtime to perform on a mounted panel. Bundled into a single WidgetCommand PluginCommand so the plugin’s TypeScript layer exposes one routing method (editor.widgetCommand(panel_id, action)) rather than a fanout of per-key IPC.

All actions target the panel’s currently focused widget (the host tracks focus per panel). They are fired by the plugin’s mode bindings — Tab → FocusAdvance{+1}, Enter → Activate, Up/Down → SelectMove{±1}, Backspace → TextInputKey{"Backspace"}, printable chars (via mode_text_input) → TextInputChar{"x"}.

Variants

FocusAdvance

Cycle focus to the next (delta=+1) or previous (delta=-1) tabbable widget in declaration order. Wraps at the ends.

Fields

delta: i32

Activate

“Activate” the focused widget — fires a semantic event keyed on widget kind: Button → widget_event { event_type: "activate" }; Toggle → widget_event { event_type: "toggle", payload: { checked: !old } }. No-op for other kinds.

SelectMove

Move the focused List’s selection by delta. Plugins listen for widget_event { event_type: "select" } to mirror the new index into their model. No-op when the focused widget isn’t a List.

Fields

delta: i32

TextInputKey

Apply a non-printable editing key to the focused TextInput: "Backspace", "Delete", "Left", "Right", "Home", "End". Host computes the new value/cursor and fires widget_event { event_type: "change", payload: { value, cursorByte } }. No-op when the focused widget isn’t a TextInput or the key isn’t recognised.

Fields

key: String

TextInputChar

Append printable text to the focused TextInput at the current cursor position. Used for the mode_text_input fall-through path. Fires widget_event as for TextInputKey.

Fields

text: String

Key

“Smart” keystroke dispatch — the host routes based on the focused widget’s kind without the plugin needing to know what’s focused. This is the recommended path for plugin mode bindings: bind every relevant key to one handler that calls editor.widgetCommand(panel_id, key("Tab")) etc.

Dispatch table:

Key	TextInput	TextArea	Toggle / Button	List	Tree	(no focus)
Tab	focus +1	focus +1	focus +1	focus +1	focus +1	no-op
Shift+Tab	focus -1	focus -1	focus -1	focus -1	focus -1	no-op
Backspace / Delete	text-edit	text-edit	no-op	no-op	no-op	no-op
Home / End	text-edit	line-start / -end	no-op	no-op	no-op	no-op
Left	text-edit	text-edit	no-op	no-op	collapse / parent	no-op
Right	text-edit	text-edit	no-op	no-op	expand	no-op
Up	no-op	line up	no-op	select -1	select -1 (visible)	no-op
Down	no-op	line down	no-op	select +1	select +1 (visible)	no-op
Enter	focus +1	insert \n	activate	activate	activate	no-op
Space	char “ “	char “ “	activate	activate	activate	no-op
(anything else)	no-op	no-op	no-op	no-op	no-op	no-op

“no-op” still returns successfully — plugins can rely on the command not erroring when the focused widget can’t handle the key. Plugins that want to fall back to their own behaviour when the widget doesn’t claim a key should bind those keys to plugin-specific handlers instead.

Fields

key: String

Trait Implementations

impl Clone for WidgetAction

fn clone(&self) -> WidgetAction

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for WidgetAction

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for WidgetAction

fn deserialize<__D>( __deserializer: __D, ) -> Result<WidgetAction, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for WidgetAction

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TS for WidgetAction

type WithoutGenerics = WidgetAction

If this type does not have generic parameters, then WithoutGenerics should just be Self. If the type does have generic parameters, then all generic parameters must be replaced with a dummy type, e.g ts_rs::Dummy or ().
The only requirement for these dummy types is that EXPORT_TO must be None.

type OptionInnerType = WidgetAction

If the implementing type is std::option::Option<T>, then this associated type is set to T. All other implementations of TS should set this type to Self instead.

fn ident(cfg: &Config) -> String

Identifier of this type, excluding generic parameters.

fn docs() -> Option<String>

JSDoc comment to describe this type in TypeScript - when TS is derived, docs are automatically read from your doc comments or #[doc = ".."] attributes

fn name(cfg: &Config) -> String

Name of this type in TypeScript, including generic parameters

fn decl_concrete(cfg: &Config) -> String

Declaration of this type using the supplied generic arguments. The resulting TypeScript definition will not be generic. For that, see TS::decl(). If this type is not generic, then this function is equivalent to TS::decl().

fn decl(cfg: &Config) -> String

Declaration of this type, e.g. type User = { user_id: number, ... }. This function will panic if the type has no declaration.

fn inline(cfg: &Config) -> String

Formats this types definition in TypeScript, e.g { user_id: number }. This function will panic if the type cannot be inlined.

fn inline_flattened(cfg: &Config) -> String

Flatten a type declaration. This function will panic if the type cannot be flattened.

fn visit_generics(v: &mut impl TypeVisitor)

where WidgetAction: 'static,

Iterates over all type parameters of this type.

fn output_path() -> Option<PathBuf>

Returns the output path to where T should be exported, relative to the output directory. The returned path does not include any base directory.

fn visit_dependencies(v: &mut impl TypeVisitor)

where WidgetAction: 'static,

Iterates over all dependency of this type.

fn dependencies(cfg: &Config) -> Vec<Dependency>

where Self: 'static,

Resolves all dependencies of this type recursively.

fn export(cfg: &Config) -> Result<(), ExportError>

where Self: 'static,

Manually export this type to the filesystem. To export this type together with all of its dependencies, use TS::export_all.

fn export_all(cfg: &Config) -> Result<(), ExportError>

where Self: 'static,

Manually export this type to the filesystem, together with all of its dependencies. To export only this type, without its dependencies, use TS::export.

fn export_to_string(cfg: &Config) -> Result<String, ExportError>

where Self: 'static,

Manually generate bindings for this type, returning a String. This function does not format the output, even if the format feature is enabled.