Option
<sc-option> | ScOption
Options define the selectable items within various form controls such as select.
<sc-select label="Select one"> <sc-option value="option-1">Option 1</sc-option> <sc-option value="option-2">Option 2</sc-option> <sc-option value="option-3">Option 3</sc-option> </sc-select>
import ScOption from '@styledc-dev/styledc/dist/react/option'; import ScSelect from '@styledc-dev/styledc/dist/react/select'; const App = () => ( <ScSelect> <ScOption value="option-1">Option 1</ScOption> <ScOption value="option-2">Option 2</ScOption> <ScOption value="option-3">Option 3</ScOption> </ScSelect> );
Examples
Disabled
Use the disabled
attribute to disable an option and prevent it from being selected.
<sc-select label="Select one"> <sc-option value="option-1">Option 1</sc-option> <sc-option value="option-2" disabled>Option 2</sc-option> <sc-option value="option-3">Option 3</sc-option> </sc-select>
import ScOption from '@styledc-dev/styledc/dist/react/option'; import ScSelect from '@styledc-dev/styledc/dist/react/select'; const App = () => ( <ScSelect> <ScOption value="option-1">Option 1</ScOption> <ScOption value="option-2" disabled> Option 2 </ScOption> <ScOption value="option-3">Option 3</ScOption> </ScSelect> );
Prefix & Suffix
Add icons to the start and end of menu items using the prefix
and suffix
slots.
<sc-select label="Select one"> <sc-option value="option-1"> <sc-icon slot="prefix" name="envelope"></sc-icon> Email <sc-icon slot="suffix" name="patch-check"></sc-icon> </sc-option> <sc-option value="option-2"> <sc-icon slot="prefix" name="telephone"></sc-icon> Phone <sc-icon slot="suffix" name="patch-check"></sc-icon> </sc-option> <sc-option value="option-3"> <sc-icon slot="prefix" name="chat-dots"></sc-icon> Chat <sc-icon slot="suffix" name="patch-check"></sc-icon> </sc-option> </sc-select>
Importing
If you’re using the autoloader or the traditional loader, you can ignore this section. Otherwise, feel free to use any of the following snippets to cherry pick this component.
To import this component from the CDN using a script tag:
<script type="module" src="https://cdn.jsdelivr.net/npm/@styledc-dev/styledc@1.0.0/cdn/components/option/option.js"></script>
To import this component from the CDN using a JavaScript import:
import 'https://cdn.jsdelivr.net/npm/@styledc-dev/styledc@1.0.0/cdn/components/option/option.js';
To import this component using a bundler:
import '@styledc-dev/styledc/dist/components/option/option.js';
To import this component as a React component:
import ScOption from '@styledc-dev/styledc/dist/react/option';
Slots
Name | Description |
---|---|
(default) | The option’s label. |
prefix
|
Used to prepend an icon or similar element to the menu item. |
suffix
|
Used to append an icon or similar element to the menu item. |
Learn more about using slots.
Properties
Name | Description | Reflects | Type | Default |
---|---|---|---|---|
value
|
The option’s value. When selected, the containing form control will receive this value. The value must be unique from other options in the same group. Values may not contain spaces, as spaces are used as delimiters when listing multiple values. |
|
string
|
''
|
disabled
|
Draws the option in a disabled state, preventing selection. |
|
boolean
|
false
|
updateComplete |
A read-only promise that resolves when the component has finished updating. |
Learn more about attributes and properties.
Methods
Name | Description | Arguments |
---|---|---|
getTextLabel() |
Returns a plain text label based on the option’s content. | - |
Learn more about methods.
Parts
Name | Description |
---|---|
checked-icon |
The checked icon, an <sc-icon> element. |
base |
The component’s base wrapper. |
label |
The option’s label. |
prefix |
The container that wraps the prefix. |
suffix |
The container that wraps the suffix. |
Learn more about customizing CSS parts.
Dependencies
This component automatically imports the following dependencies.
<sc-icon>