A Vue component that implements the WAI-ARIA authoring practices for a Combobox.
I am no regular screenreader user. I followed the authoring practices to the best of my understanding. If something seems off, please open an issue.
The current implementation only covers the List autocomplete with manual selection part of the authoring practices.
No rocket science here. Although rockets are cool, tbh. 🚀 Just install the component from npm.
npm install @tournant/combobox --save-dev
If you use Yarn:
yarn add -D @tournant/combobox
Once the component is installed you need to import wherever you want to use it.
Don’t forget to add it to the registered components (been there, done that):
components:TournantCombobox// ... all the other amazing components
You can find a live demo on @tournant/ui.code.ovl.design.
items: An array of items to be displayed. The items of the array must be objects that have a
idproperty. If an empty array is passed, the message set in the
noResultsMessageprop is shown. Defaults to an empty array.
inputLabel: The label text of the input. Required.
isStyled: Whether or not default styles should be applied. Defaults to false. See section Styles below.
noResultsMessage: Text that should be shown if no results can be passed. Required.
input: The component emits an input event if the value of the textbox changes. Please note that this is not debounced or throttled.
clickon an item emit the ID of the result.
The combobox exposes the following CSS classes for its parts:
By default no styles will be attached to these classes.
isStyled prop to
true will enable some default styles. Those are scoped by adding the
--is-styled modifier to the respective element.
These styles add some little helpers (e.g. limiting the width, removing list styles, add
position: absolute to the list) and some minor styling.
You can adapt spacing and color of the component by accessing the following Custom Properties (supporting browsers):
|--t-ui-cb-clr-light||rgb(206, 206, 206)|
Bugs & Enhancements
If you found a bug, please create a bug ticket.
For enhancements please refer to the contributing guidelines.
This project is licensed under the MIT license.