Skip to content
luxe API

luxe: selection

Selection

Section titled “Selection”
import "luxe: selection" for Selection

no docs found

Selection.CHANGE

Section titled “Selection.CHANGE”
Selection.CHANGE : unknown

no docs found

Selection.DESELECT

Section titled “Selection.DESELECT”
Selection.DESELECT : unknown

no docs found

Selection.SELECT

Section titled “Selection.SELECT”
Selection.SELECT : unknown

no docs found

Selection.INVALID

Section titled “Selection.INVALID”
Selection.INVALID : unknown

no docs found

Selection.PRE_CHANGE

Section titled “Selection.PRE_CHANGE”
Selection.PRE_CHANGE : unknown

no docs found

Selection.id

Section titled “Selection.id”
Selection.id : String

no docs found

Selection.events

Section titled “Selection.events”
Selection.events : Events

no docs found

Selection.selected

Section titled “Selection.selected”
Selection.selected : List

no docs found

Selection.any(.)

Section titled “Selection.any(.)”
Selection.any() : Bool

no docs found

Selection.is_selected(.)

Section titled “Selection.is_selected(.)”
Selection.is_selected(value : Any) : Bool

no docs found

Selection.is_selected(..)

Section titled “Selection.is_selected(..)”
Selection.is_selected(value : Any, non_transient_only : Bool) : Bool

no docs found

Selection.is_invalid_selection(.)

Section titled “Selection.is_invalid_selection(.)”
Selection.is_invalid_selection(value : Any) : String

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

Selection.count

Section titled “Selection.count”
Selection.count : Num

no docs found

Selection.first

Section titled “Selection.first”
Selection.first : Any

no docs found

Selection.last

Section titled “Selection.last”
Selection.last : Any

no docs found

Selection.transient

Section titled “Selection.transient”
Selection.transient : Bool

no docs found

Selection.new(.)

Section titled “Selection.new(.)”
Selection.new(context : String) : Selection

no docs found

Selection.destroy(.)

Section titled “Selection.destroy(.)”
Selection.destroy() : unknown

no docs found

Selection.emit(..)

Section titled “Selection.emit(..)”
Selection.emit(kind : Any, items : List) : unknown

no docs found

Selection.start_transient(.)

Section titled “Selection.start_transient(.)”
Selection.start_transient(change : Fn) : unknown

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

Selection.end_transient(.)

Section titled “Selection.end_transient(.)”
Selection.end_transient() : None

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

Selection.sync(.)

Section titled “Selection.sync(.)”
Selection.sync(other : Selection) : unknown

Sync selection with another instance.

Selection.unsync(.)

Section titled “Selection.unsync(.)”
Selection.unsync(other : Selection) : unknown

Stop syncing selection.

Selection.deselect(.)

Section titled “Selection.deselect(.)”
Selection.deselect() : unknown

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

Selection.deselect(.)

Section titled “Selection.deselect(.)”
Selection.deselect(item : Any) : unknown

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

Selection.deselect_items(.)

Section titled “Selection.deselect_items(.)”
Selection.deselect_items(items : List) : unknown

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

Selection.select(.)

Section titled “Selection.select(.)”
Selection.select(item : Any) : unknown

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

Selection.select(..)

Section titled “Selection.select(..)”
Selection.select(item : Any, plural : Bool) : 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(.)

Section titled “Selection.select_items(.)”
Selection.select_items(items : List) : None

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

Selection.select_items(..)

Section titled “Selection.select_items(..)”
Selection.select_items(items : List, plural : Bool) : 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(.)

Section titled “Selection.toggle(.)”
Selection.toggle(item : Any) : unknown

no docs found

Selection.notify(.)

Section titled “Selection.notify(.)”
Selection.notify() : None

send a change event for the selection

Selection.set_invalid_handler(.)

Section titled “Selection.set_invalid_handler(.)”
Selection.set_invalid_handler(fn : Fn) : unknown

no docs found