o-multi-select
An Origami component for selecting multiple options.
Usage
Check out how to include Origami components in your project to get started with o-multi-select
.
Markup
o-multi-select
expects options to be provided in a <select>
tag. The component will automatically enhance the experience for users with JavaScript enabled.
The value must not contain whitespace characters, as it should be valid as an id attribute
<div class="o-multi-select" data-o-component="o-multi-select">
<select name="multiple" id="fruits" multiple>
<option value="Apple">Apple</option>
<option value="Banana">Banana</option>
</select>
</div>
To style form labels, we recommend using o-forms.
Below is an example of how to combine o-forms and o-multi-select components together. Note the label
and select
element are connected using for
and id
attributes.
<form data-o-component="o-forms">
<label for="fruits" class="o-forms-field">
<span class="o-forms-title">
<span class="o-forms-title__main">Select multiple options</span>
</span>
</label>
<div class="o-forms-input">
<div class="o-multi-select" data-o-component="o-multi-select">
<select name="multiple" id="fruits" multiple>
<option value="Apple">Apple</option>
<option value="Banana">Banana</option>
</select>
</div>
</div>
</form>
Using TSX templates
If you are using TSX templates we recommend that you also import GenericInput
and Form
from o-forms
. This will style labels and options for your TSX component. And you will also need to initialise component javascript in correct lifecycle of your competent. Bellow is an example for react users.
import {Form, GenericInput} from '@financial-times/o-forms/src/tsx/Form';
import {MultiSelect} from '@financial-times/o-multi-select/src/tsx/multi-select';
export const MultiSelectDefault = args => {
return (
<Form>
<GenericInput id={args.id} title={args.title}>
<MultiSelect {...args} />
</GenericInput>
</Form>
);
};
Sass
Use @include oMultiSelect()
to include styles for all o-multi-select
features.
@import '@financial-times/o-multi-select';
@include oMultiSelect();
JavaScript
JavaScript is initialised automatically for Origami Build Service users.
If your project is using a manual build process, initialise o-multi-select
manually. For example call the init
method to initialise all o-multi-select
instances in the document:
import oMultiSelect from 'o-multi-select';
oMultiSelect.init();
Or pass an element to initialise a specific o-multi-select
instance:
import oMultiSelect from 'o-multi-select';
const oMultiSelectElement = document.getElementById(
'#my-o-multi-select-element'
);
oMultiSelect.init(oMultiSelectElement);
Events
o-multi-select
dispatches a custom event oMultiSelect.OptionChange
that bubbles. It is triggered when an option gets selected or removed. The event data has the following interface:
detail: {
optionElement: HTMLelement,
value: string,
selected: boolean,
index: number,
instance,
}
Keyboard Support
When focus is within the combobox input and the suggestions menu is closed
Key | Function |
---|
Enter, Space, Up Arrow or Down Arrow | All these keys will expand the suggestions menu, and focus will be on the first option, or the most recently highlighted option. |
Key | Function |
---|
Enter | - Selects content of the focused option in the suggestions menu.
- Prevents form submission.
- Creates selected option as button with remove icon.
|
Space | - Selects content of the focused option in the suggestions menu.
- Creates selected option as button with remove icon.
|
Tab | - Closes the suggestions menu.
- Focus moves to next focusable element
|
Up Arrow | moves focus to the previous option, if one exists. If focus is already on the first option, it will not move. |
Down Arrow | moves focus to the next option, if one exists. If focus is already on the last option, it will not move. |
PageUp | Jumps visual focus up 10 options (or to first option). |
PageDown | Jumps visual focus down 10 options (or to last option). |
Home/End | moves focus to the first or last option. |
Escape | - Returns focus to the combobox element
- closes the dropdown without modifying the selected options.
|
Migration
State | Major Version | Last Minor Release | Migration guide |
---|
✨ active | 2 | 2.0 | migrate to v2 |
⚠ maintained | 1 | 1.0 | N/A |
Contact
If you have any questions or comments about this component, or need help using it, please either raise an issue, visit #origami-support or email origami.support@ft.com.
Licence
This software is published by the Financial Times under the MIT licence.