DropDown
Overview
Field for selecting an option from a possible list
import { DropDown } from '@ska-telescope/ska-gui-components';
...
<DropDown label="DropDown Label" options={DROP_DOWN_OPTIONS} testId="testId" value={DROP_DOWN_VALUE} />
Property |
Type |
Required |
default |
|
---|---|---|---|---|
ariaDescription |
string |
No |
Used by Screen Readers |
|
ariaTitle |
string |
No |
AlertCard |
Used by Screen Readers |
disabled |
boolean |
No |
false |
Disables the component if true |
errorText |
string |
No |
‘’ |
Displayed if there is a value and component is coloured |
helperText |
string |
No |
‘’ |
Displayed is there is a value |
label |
string |
Yes |
Label displayed for the Component |
|
labelBold |
boolean |
No |
false |
Label is displayed in bold unless disabled |
labelPosition |
LABEL_POSITION |
No |
LABEL_POSITION.CONTAINED |
Allows for the positioning of the label |
onFocus |
Function |
No |
Function executed when the component is active |
|
options |
Yes |
Options to be displayed for selection. See below |
||
required |
boolean |
No |
false |
Asterisk is added to the label if true |
setValue |
function |
No |
null |
Used to update the value onChange |
testId |
string |
Yes |
Identifier for testing purposes |
|
value |
string |
Yes |
Value that is displayed within the component |
Constants
- header:
“Constant”, “Values”, “Usage”
“LABEL_POSITION”, “Contained, Top, Bottom, Start, End”, “Allows for the positioning of the label”
Testing Identifier
Provided by the property testId