Enum UiComponent 

pub enum UiComponent {
    Group {
        label: String,
        children: Vec<UiComponent>,
    },
    Row {
        children: Vec<UiComponent>,
    },
    Column {
        children: Vec<UiComponent>,
    },
    Tabs {
        tabs: Vec<UiTab>,
    },
    Knob {
        label: String,
        param_id: u32,
        min: f32,
        max: f32,
        logarithmic: bool,
    },
    Slider {
        label: String,
        param_id: u32,
        min: f32,
        max: f32,
    },
    Toggle {
        label: String,
        param_id: u32,
    },
    Dropdown {
        label: String,
        param_id: u32,
        options: Vec<String>,
    },
    ButtonGroup {
        label: String,
        param_id: u32,
        options: Vec<String>,
    },
    ColorPicker {
        label: String,
        r_param_id: u32,
        g_param_id: u32,
        b_param_id: u32,
    },
    HueSlider {
        label: String,
        param_id: u32,
    },
    XYPad {
        label: String,
        x_param_id: u32,
        y_param_id: u32,
    },
    Curves {
        label: String,
        param_id: u32,
    },
    AudioScope {
        label: String,
        source: AudioSource,
    },
    BeatButton {
        label: String,
        trigger_id: u32,
        division: NoteDivision,
    },
    ActionButton {
        label: String,
        action_id: String,
    },
    TriggerButton {
        label: String,
        param_id: u32,
    },
    ModulationSlot {
        label: String,
        target_param_id: u32,
    },
    ControlPreview {
        label: String,
        port_name: String,
        history_length: u32,
    },
    ControlTargetSelector {
        label: String,
        port_name: String,
    },
    Label {
        text: String,
    },
    Separator,
    Spacer {
        height: f32,
    },
    Custom {
        widget_id: String,
        props: HashMap<String, String>,
    },
}

UI Component - the AST of the UI DSL

MODs return this structure to define their UI. Host interprets and renders using egui.

Variants

Group

Grouped section with label

Fields

label: String

children: Vec<UiComponent>

Row

Horizontal row of components

Fields

children: Vec<UiComponent>

Column

Vertical column of components

Fields

children: Vec<UiComponent>

Tabs

Tabbed sections

Fields

tabs: Vec<UiTab>

Knob

Rotary knob (best for VJ performance)

Fields

label: String

param_id: u32

min: f32

max: f32

logarithmic: bool

Slider

Horizontal slider

Fields

label: String

param_id: u32

min: f32

max: f32

Toggle

On/off toggle

Fields

label: String

param_id: u32

Dropdown

Dropdown selection

Fields

label: String

param_id: u32

options: Vec<String>

ButtonGroup

Button group (radio button style for VJ)

Fields

label: String

param_id: u32

options: Vec<String>

ColorPicker

Color picker (RGB) - for 3-param use cases

Fields

label: String

r_param_id: u32

g_param_id: u32

b_param_id: u32

HueSlider

Hue slider (single param) - for WIT ColorPicker (0.0 = red, 1.0 = red wrap)

Fields

label: String

param_id: u32

XYPad

2D XY pad controller

Fields

label: String

x_param_id: u32

y_param_id: u32

Curves

Bezier curve editor

Fields

label: String

param_id: u32

AudioScope

Audio waveform/spectrum visualizer

Fields

label: String

source: AudioSource

BeatButton

Beat-synced trigger button

Fields

label: String

trigger_id: u32

division: NoteDivision

ActionButton

Action button (one-shot trigger via Action System)

Fields

label: String

action_id: String

TriggerButton

Trigger button - param-based one-shot (sends 1.0 for one frame, auto-resets to 0.0)

Fields

label: String

param_id: u32

ModulationSlot

Modulation source slot (for patching)

Fields

label: String

target_param_id: u32

ControlPreview

Control signal preview (waveform display for LFO, envelope, etc.)

Fields

label: String

port_name: String

history_length: u32

History buffer for waveform display (values 0.0-1.0)

ControlTargetSelector

Control target selector for ControlOutput nodes (LFO, etc.)

Displays a dropdown to select which node/parameter this control output should modulate. The actual connection is managed by the host.

Fields

label: String

port_name: String

The control output port name (e.g., “output”)

Label

Static label text

Fields

text: String

Separator

Separator line

Spacer

Spacer

Fields

height: f32

Custom

Custom widget rendered by host

For complex widgets that can’t be expressed in DSL. Host looks up a custom renderer by widget_id.

Fields

widget_id: String

props: HashMap<String, String>

Implementations

impl UiComponent

pub fn group(label: impl Into<String>, children: Vec<UiComponent>) -> Self

Create a group

pub fn row(children: Vec<UiComponent>) -> Self

Create a row

pub fn column(children: Vec<UiComponent>) -> Self

Create a column

pub fn knob(label: impl Into<String>, param_id: u32, min: f32, max: f32) -> Self

Create a knob

pub fn knob_log( label: impl Into<String>, param_id: u32, min: f32, max: f32, ) -> Self

Create a logarithmic knob

pub fn slider( label: impl Into<String>, param_id: u32, min: f32, max: f32, ) -> Self

Create a slider

pub fn toggle(label: impl Into<String>, param_id: u32) -> Self

Create a toggle

pub fn dropdown( label: impl Into<String>, param_id: u32, options: Vec<String>, ) -> Self

Create a dropdown

pub fn button_group( label: impl Into<String>, param_id: u32, options: Vec<String>, ) -> Self

Create a button group

pub fn xy_pad( label: impl Into<String>, x_param_id: u32, y_param_id: u32, ) -> Self

Create an XY pad

pub fn audio_scope(label: impl Into<String>, source: AudioSource) -> Self

Create an audio scope

pub fn beat_button( label: impl Into<String>, trigger_id: u32, division: NoteDivision, ) -> Self

Create a beat button

pub fn action_button( label: impl Into<String>, action_id: impl Into<String>, ) -> Self

Create an action button (one-shot trigger via Action System)

pub fn trigger_button(label: impl Into<String>, param_id: u32) -> Self

Create a trigger button (param-based one-shot, auto-resets to 0.0)

pub fn mod_slot(label: impl Into<String>, target_param_id: u32) -> Self

Create a modulation slot

pub fn control_preview( label: impl Into<String>, port_name: impl Into<String>, history_length: u32, ) -> Self

Create a control preview (waveform display for control signals)

pub fn control_target_selector( label: impl Into<String>, port_name: impl Into<String>, ) -> Self

Create a control target selector (for ControlOutput nodes like LFO)

pub fn label(text: impl Into<String>) -> Self

Create a label

pub fn separator() -> Self

Create a separator

pub fn spacer(height: f32) -> Self

Create a spacer

pub fn custom(widget_id: impl Into<String>) -> Self

Create a custom widget

pub fn custom_with_props( widget_id: impl Into<String>, props: HashMap<String, String>, ) -> Self

Create a custom widget with properties

Trait Implementations

impl Clone for UiComponent

fn clone(&self) -> UiComponent

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for UiComponent

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for UiComponent

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for UiComponent

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

where __S: Serializer,

Serialize this value into the given Serde serializer.