Select

class UI.Select

This documentation is a work in progress. UI scripting is a new feature, and additional content is still being added. Stay tuned for updates!

Attribute
Value

label

any string This value is required.

items

a list of items to display. Example: [{

"id": "one",

"title": "Item 1",

"iconUrl": "https://i.com/image.png"

}]

id: Must be unique. Duplicate IDs can cause unexpected behavior and may result in incorrect UI rendering. Ensure each ID is distinct to avoid issues.

id & title are required, iconUrl is optional

Default: None

selected_items

a list of (item) ids to display. Default: None

disabled_items

a list of (item) ids to disable. Default: None

mode

"single"

"multiple" Default: "single"

description

any string Default: None

loading

True | False Default: False

disabled

True | False Default: False

invalid

True | False Default: False

error_message

any string Default: None

full_width

True | False Default: False

margin

See Margin. Default: "m-0"

visible

See Visible. Default: True

Events

Event
Arguments
Description

onChange

selected_items (list)

Triggered when the selection changes.

Last updated

Was this helpful?