Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

@financial-times/o-multi-select

Package Overview
Dependencies
Maintainers
10
Versions
14
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

@financial-times/o-multi-select

Multi select component

  • 2.2.7
  • latest
  • npm
  • Socket score

Version published
Weekly downloads
283
increased by2.17%
Maintainers
10
Weekly downloads
 
Created
Source

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>
		<!--More options -->
	</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>
				<!--More options -->
			</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, // The elements that was selected or deselected
  value: string, // Value of selected/deselected option
  selected: boolean, // If element is selected or not
  index: number, // Index of option in the array of options
  instance, // Instance of multiselect element
}

Keyboard Support

When focus is within the combobox input and the suggestions menu is closed

KeyFunction
Enter, Space, Up Arrow or Down ArrowAll these keys will expand the suggestions menu, and focus will be on the first option, or the most recently highlighted option.

When focus is within the suggestions menu

KeyFunction
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 Arrowmoves focus to the previous option, if one exists. If focus is already on the first option, it will not move.
Down Arrowmoves focus to the next option, if one exists. If focus is already on the last option, it will not move.
PageUpJumps visual focus up 10 options (or to first option).
PageDownJumps visual focus down 10 options (or to last option).
Home/Endmoves focus to the first or last option.
Escape
  • Returns focus to the combobox element
  • closes the dropdown without modifying the selected options.

Migration

StateMajor VersionLast Minor ReleaseMigration guide
✨ active22.0migrate to v2
⚠ maintained11.0N/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.

Keywords

FAQs

Package last updated on 15 May 2024

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc