Select component is a component that allows users pick a value from predefined options. Ideally, it should be used when there are more than 5 options, otherwise you might consider using a radio group instead.
Here's a basic usage of the Select component.
There are three sizes of select : large (48px), default (40px) and small (32px).
Just like the input component, select comes in 3 variants, outline
, unstyled
, flushed
, and filled
. Pass the variant
prop and set it to either of
these values.
As with most Chakra components, you can change the arrow icon used in the
select. Simply pass the icon
prop.
In case the custom icon size doesn't look right, you can pass the iconSize
prop to change it.
Even though the select comes with predefined styles, you can override pretty much any property. Here's we'll override the background color.
The Select component composes Box so you can pass all Box
props, and native select
props in addition to these:
Name | Type | Default | Description |
---|---|---|---|
size | sm , md , lg | md | The visual size of the select element. |
icon | React.ReactElement , string | <ChevronDown/> | The icon to use in place if the chevron-down |
iconSize | BoxProps['size'] | 20px | The visual size of the default icon |
iconColor | BoxProps['color'] | The color of the default icon | |
variant | outline , unstyled , flushed , filled | outline | The variant of the select style to use. |
focusBorderColor | string | The border color when the select is focused. | |
errorBorderColor | string | The border color when isInvalid is set to true . | |
isDisabled | boolean | false | If true , the select will be disabled. This sets aria-disabled=true and you can style this state by passing _disabled prop. |
isInvalid | boolean | false | If true , the select will indicate an error. This sets aria-invalid=true and you can style this state by passing _invalid prop. |
isRequired | boolean | false | If true , the select element will be required. |
isReadOnly | boolean | false | If true , prevents the value of the select from being edited. |
rootProps | BoxProps | The props to pass to the wrapper of the select. The select is wrapped in a Box to help align the icon, if you want to pass some props to that wrapper, use this prop |