sandstone/ Picker
A component for selecting values from a list of values.
import Picker from '@enact/sandstone/Picker';
Members
PickerComponent
A Picker component that allows selecting values from a list of values.
By default, Picker
maintains the state of its value
property. Supply the defaultValue
property to control its initial value. If you wish to directly control updates to the component,
supply a value to value
at creation time and update it in response to onChange
events.
import Picker from '@enact/sandstone/Picker';
Properties
Default index of the selected child.
Note: Changing
defaultValue
after initial render has no effect.
PickerBaseComponent
The base Picker
component.
This version is not spottable.
import {PickerBase} from '@enact/sandstone/Picker';
Properties
Picker value list.
The
aria-valuetext
for the picker.By default,
aria-valuetext
is set to the current selected child text.The voice control labels for the
children
.By default,
data-webos-voice-labels-ext
is generated fromchildren
. However, ifchildren
is not an array of numbers or strings,data-webos-voice-labels-ext
should be set to an array of labels.A custom icon for the decrementer.
All strings supported by Icon are supported. Without a custom icon, the default is used, and is automatically changed when the orientation is changed.
Disables the picker.
A custom icon for the incrementer.
All strings supported by Icon are supported. Without a custom icon, the default is used, and is automatically changed when the orientation is changed.
Allows the user to use the arrow keys to adjust the picker's value.
Key presses are captured in the directions of the increment and decrement buttons but others are unaffected. A non-joined Picker allows navigation in any direction, but requires individual ENTER presses on the incrementer and decrementer buttons. Pointer interaction is the same for both formats.
Disables marqueeing of items.
By default, each picker item is wrapped by a Marquee. When this is set, the items will not be wrapped.
Disables transition animation.
Called when the
value
changes.Orientation of the picker.
Controls whether the buttons are arranged horizontally or vertically around the value.
Index of the selected child.
Default: 0The width of the picker.
A number can be used to set the minimum number of characters to be shown. Setting a number to less than the number of characters in the longest value will cause the width to grow for the longer values.
A string can be used to select from pre-defined widths:
'small'
- numeric values'medium'
- single or short words'large'
- maximum-sized pickers taking full width of its parent
By default, the picker will size according to the longest valid value.
Allows picker to continue from the start of the list after it reaches the end and vice-versa.