luxe API (2025.1.2)

---

luxe: selection module

• Selection

---

Selection

import "luxe: selection" for Selection

no docs found

• CHANGE
• DESELECT
• SELECT
• INVALID
• PRE_CHANGE
• id
• events
• selected
• any()
• is_selected(value: Any)
• is_selected(value: Any, non_transient_only: Bool)
• is_invalid_selection(value: Any)
• count
• first
• last
• transient
• new(context: String)
• destroy()
• emit(kind: Any, items: List)
• start_transient(change: Fn)
• end_transient()
• sync(other: Selection)
• unsync(other: Selection)
• deselect()
• deselect(item: Any)
• deselect_items(items: List)
• select(item: Any)
• select(item: Any, plural: Bool)
• select_items(items: List)
• select_items(items: List, plural: Bool)
• toggle(item: Any)
• notify()
• set_invalid_handler(fn: Fn)

---

Selection.CHANGE returns unknown

no docs found

Selection.DESELECT returns unknown

no docs found

Selection.SELECT returns unknown

no docs found

Selection.INVALID returns unknown

no docs found

Selection.PRE_CHANGE returns unknown

no docs found

Selection.id returns String

no docs found

Selection.events returns Events

no docs found

Selection.selected returns List

no docs found

Selection.any() returns Bool

no docs found

Selection.is_selected(value: Any) returns Bool

no docs found

Selection.is_selected(value: Any, non_transient_only: Bool) returns Bool

no docs found

Selection.is_invalid_selection(value: Any) returns String

returns a string as a reason if not able to select, otherwise returns null

Selection.count returns Num

no docs found

Selection.first returns Any

no docs found

Selection.last returns Any

no docs found

Selection.transient returns Bool

no docs found

Selection.new(context: String) returns Selection

no docs found

Selection.destroy() returns unknown

no docs found

Selection.emit(kind: Any, items: List) returns unknown

no docs found

Selection.start_transient(change: Fn) returns unknown

Start a transient selection where changes will be stored separately and notifed of a change directly

Selection.end_transient() returns None

End a transient selection, read .selected before calling to capture the transient selection

Selection.sync(other: Selection) returns unknown

Sync selection with another instance.

Selection.unsync(other: Selection) returns unknown

Stop syncing selection.

Selection.deselect() returns unknown

Clear the selection. emits DESELECT with a list of items deselected

Selection.deselect(item: Any) returns unknown

Deselect the given item. emits DESELECT with a list containing the item

Selection.deselect_items(items: List) returns unknown

Deselect the given items. emits DESELECT with a list containing the items (ones that were actually selected)

Selection.select(item: Any) returns unknown

select the given item. emits SELECT with a list containing the item

Selection.select(item: Any, plural: Bool) returns unknown

Select the given item, and if plural is true, the item is added to the existing selection. If not, the selection is cleared and only this item is selected afterward. Emits SELECT with a list containing the item

Selection.select_items(items: List) returns None

Select multiple items. Replaces the current selection. Emits SELECT with a list containing the items

Selection.select_items(items: List, plural: Bool) returns None

Select the given items, and if plural is true, the items are added to the existing selection. If not, the selection is cleared and only the items are selected afterward. Emits SELECT with a list containing the items

Selection.toggle(item: Any) returns unknown

no docs found

Selection.notify() returns None

send a change event for the selection

Selection.set_invalid_handler(fn: Fn) returns unknown

no docs found