Skip to content

list-picker.md

Latest commit

 

History

History
67 lines (48 loc) · 1.74 KB

list-picker.md

File metadata and controls

67 lines (48 loc) · 1.74 KB
title ListPicker
description UI component for selecting a value from a list.
contributors
rigor789
Ombuweb

<ListPicker> is a UI component that lets the user select a value from a pre-configured list.

<<< @/../examples/typescript/src/ui/ListPicker/template.xml#example <<< @/../examples/typescript/src/ui/ListPicker/template.ts#example

<<< @/../examples/angular/src/ui/ListPicker/component.html#example <<< @/../examples/angular/src/ui/ListPicker/component.ts#example <<< @/../examples/react/src/components/ui/label.tsx#example <<< @/../examples/solid/src/ui/label.tsx#example <<< @/../examples/svelte/app/components/ui/ListPicker.svelte#example <<< @/../examples/vue/src/ui/ListPicker/component.vue#example

Props

items

items: Array<string | number>

Gets or sets the items of the ListPicker.

selectedIndex

selectedIndex: number

Gets or sets the index of the currently selected item.

...Inherited

For additional inherited properties, refer to the API Reference.

Events

selectedIndexChange

on('selectedIndexChange', (args: PropertyChangeData) => {
  const picker = args.object as ListPicker
  console.log('selectedIndex changed to', args.value)
  // or picker.selectedIndex
})

Emitted when the currently selected item (index) changes.

Native component