2023-02-28 08:29:30 +00:00
|
|
|
<template>
|
|
|
|
|
<DocSectionText id="accessibility" label="Accessibility" v-bind="$attrs">
|
|
|
|
|
<h3>Screen Reader</h3>
|
|
|
|
|
<p>
|
|
|
|
|
Value to describe the component can either be provided with <i>aria-labelledby</i> or <i>aria-label</i> props. The multiselect component has a <i>combobox</i> role in addition to <i>aria-haspopup</i> and <i>aria-expanded</i> attributes.
|
|
|
|
|
The relation between the combobox and the popup is created with <i>aria-controls</i> attribute that refers to the id of the popup listbox.
|
|
|
|
|
</p>
|
|
|
|
|
<p>The popup listbox uses <i>listbox</i> as the role with <i>aria-multiselectable</i> enabled. Each list item has an <i>option</i> role along with <i>aria-label</i>, <i>aria-selected</i> and <i>aria-disabled</i> attributes.</p>
|
|
|
|
|
|
|
|
|
|
<p>
|
|
|
|
|
Checkbox component at the header uses a hidden native checkbox element internally that is only visible to screen readers. Value to read is defined with the <i>selectAll</i> and <i>unselectAll</i> keys of the <i>aria</i> property from the
|
2023-03-08 11:28:36 +00:00
|
|
|
<NuxtLink to="/configuration/#locale">locale</NuxtLink> API.
|
2023-02-28 08:29:30 +00:00
|
|
|
</p>
|
|
|
|
|
|
|
|
|
|
<p>If filtering is enabled, <i>filterInputProps</i> can be defined to give <i>aria-*</i> props to the input element.</p>
|
|
|
|
|
|
2023-03-08 11:28:36 +00:00
|
|
|
<p>Close button uses <i>close</i> key of the <i>aria</i> property from the <NuxtLink to="/configuration/#locale">locale</NuxtLink> API as the <i>aria-label</i> by default, this can be overriden with the <i>closeButtonProps</i>.</p>
|
2023-02-28 08:29:30 +00:00
|
|
|
|
2023-02-28 17:40:48 +00:00
|
|
|
<DocSectionCode :code="code" hideToggleCode hideCodeSandbox hideStackBlitz v-bind="$attrs" />
|
2023-02-28 08:29:30 +00:00
|
|
|
|
|
|
|
|
<h3>Closed State Keyboard Support</h3>
|
|
|
|
|
<div class="doc-tablewrapper">
|
|
|
|
|
<table class="doc-table">
|
|
|
|
|
<thead>
|
|
|
|
|
<tr>
|
|
|
|
|
<th>Key</th>
|
|
|
|
|
<th>Function</th>
|
|
|
|
|
</tr>
|
|
|
|
|
</thead>
|
|
|
|
|
<tbody>
|
|
|
|
|
<tr>
|
|
|
|
|
<td><i>tab</i></td>
|
|
|
|
|
<td>Moves focus to the multiselect element.</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td><i>space</i></td>
|
|
|
|
|
<td>Opens the popup and moves visual focus to the selected option, if there is none then first option receives the focus.</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td><i>enter</i></td>
|
|
|
|
|
<td>Opens the popup and moves visual focus to the selected option, if there is none then first option receives the focus.</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td><i>down arrow</i></td>
|
|
|
|
|
<td>Opens the popup and moves visual focus to the selected option, if there is none then first option receives the focus.</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td><i>up arrow</i></td>
|
|
|
|
|
<td>Opens the popup and moves visual focus to the selected option, if there is none then first option receives the focus.</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td><i>any printable character</i></td>
|
|
|
|
|
<td>Opens the popup and moves focus to the option whose label starts with the characters being typed, if there is none then first option receives the focus.</td>
|
|
|
|
|
</tr>
|
|
|
|
|
</tbody>
|
|
|
|
|
</table>
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<h3>Popup Keyboard Support</h3>
|
|
|
|
|
<div class="doc-tablewrapper">
|
|
|
|
|
<table class="doc-table">
|
|
|
|
|
<thead>
|
|
|
|
|
<tr>
|
|
|
|
|
<th>Key</th>
|
|
|
|
|
<th>Function</th>
|
|
|
|
|
</tr>
|
|
|
|
|
</thead>
|
|
|
|
|
<tbody>
|
|
|
|
|
<tr>
|
|
|
|
|
<td><i>tab</i></td>
|
|
|
|
|
<td>Moves focus to the next focusable element in the popup, if there is none then first focusable element receives the focus.</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td><i>shift</i> + <i>tab</i></td>
|
|
|
|
|
<td>Moves focus to the previous focusable element in the popup, if there is none then last focusable element receives the focus.</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td><i>enter</i></td>
|
|
|
|
|
<td>Toggles the selection state of the focused option, then moves focus to the multiselect element.</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td><i>space</i></td>
|
|
|
|
|
<td>Toggles the selection state of the focused option, then moves focus to the multiselect element.</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td><i>escape</i></td>
|
|
|
|
|
<td>Closes the popup, moves focus to the multiselect element.</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td><i>down arrow</i></td>
|
|
|
|
|
<td>Moves focus to the next option, if there is none then visual focus does not change.</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td><i>up arrow</i></td>
|
|
|
|
|
<td>Moves focus to the previous option, if there is none then visual focus does not change.</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td><i>alt</i> + <i>up arrow</i></td>
|
|
|
|
|
<td>Selects the focused option and closes the popup, then moves focus to the multiselect element.</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td><i>shift</i> + <i>down arrow</i></td>
|
|
|
|
|
<td>Moves focus to the next option and toggles the selection state.</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td><i>shift</i> + <i>up arrow</i></td>
|
|
|
|
|
<td>Moves focus to the previous option and toggles the selection state.</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td><i>shift</i> + <i>space</i></td>
|
|
|
|
|
<td>Selects the items between the most recently selected option and the focused option.</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td><i>home</i></td>
|
|
|
|
|
<td>Moves focus to the first option.</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td><i>end</i></td>
|
|
|
|
|
<td>Moves focus to the last option.</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td><i>control</i> + <i>shift</i> + <i>home</i></td>
|
|
|
|
|
<td>Selects the focused options and all the options up to the first one.</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td><i>control</i> + <i>shift</i> + <i>end</i></td>
|
|
|
|
|
<td>Selects the focused options and all the options down to the last one.</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td><i>control</i> + <i>a</i></td>
|
|
|
|
|
<td>Selects all options.</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td><i>pageUp</i></td>
|
|
|
|
|
<td>Jumps visual focus to first option.</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td><i>pageDown</i></td>
|
|
|
|
|
<td>Jumps visual focus to last option.</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td><i>any printable character</i></td>
|
|
|
|
|
<td>Moves focus to the option whose label starts with the characters being typed.</td>
|
|
|
|
|
</tr>
|
|
|
|
|
</tbody>
|
|
|
|
|
</table>
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<h3>Toggle All Checkbox Keyboard Support</h3>
|
|
|
|
|
<div class="doc-tablewrapper">
|
|
|
|
|
<table class="doc-table">
|
|
|
|
|
<thead>
|
|
|
|
|
<tr>
|
|
|
|
|
<th>Key</th>
|
|
|
|
|
<th>Function</th>
|
|
|
|
|
</tr>
|
|
|
|
|
</thead>
|
|
|
|
|
<tbody>
|
|
|
|
|
<tr>
|
|
|
|
|
<td><i>space</i></td>
|
|
|
|
|
<td>Toggles the checked state.</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td><i>escape</i></td>
|
|
|
|
|
<td>Closes the popup and moves focus to the multiselect element.</td>
|
|
|
|
|
</tr>
|
|
|
|
|
</tbody>
|
|
|
|
|
</table>
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<h3>Filter Input Keyboard Support</h3>
|
|
|
|
|
<div class="doc-tablewrapper">
|
|
|
|
|
<table class="doc-table">
|
|
|
|
|
<thead>
|
|
|
|
|
<tr>
|
|
|
|
|
<th>Key</th>
|
|
|
|
|
<th>Function</th>
|
|
|
|
|
</tr>
|
|
|
|
|
</thead>
|
|
|
|
|
<tbody>
|
|
|
|
|
<tr>
|
|
|
|
|
<td><i>down arrow</i></td>
|
|
|
|
|
<td>Moves focus to the next option, if there is none then visual focus does not change.</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td><i>up arrow</i></td>
|
|
|
|
|
<td>Moves focus to the previous option, if there is none then visual focus does not change.</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td><i>left arrow</i></td>
|
|
|
|
|
<td>Removes the visual focus from the current option and moves input cursor to one character left.</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td><i>right arrow</i></td>
|
|
|
|
|
<td>Removes the visual focus from the current option and moves input cursor to one character right.</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td><i>home</i></td>
|
|
|
|
|
<td>Moves input cursor at the end, if not then moves focus to the first option.</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td><i>end</i></td>
|
|
|
|
|
<td>Moves input cursor at the beginning, if not then moves focus to the last option.</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td><i>enter</i></td>
|
|
|
|
|
<td>Closes the popup and moves focus to the multiselect element.</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td><i>escape</i></td>
|
|
|
|
|
<td>Closes the popup and moves focus to the multiselect element.</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td><i>tab</i></td>
|
|
|
|
|
<td>Moves focus to the next focusable element in the popup. If there is none, the focusable option is selected and the overlay is closed then moves focus to next element in page.</td>
|
|
|
|
|
</tr>
|
|
|
|
|
</tbody>
|
|
|
|
|
</table>
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<h3>Close Button Keyboard Support</h3>
|
|
|
|
|
<div class="doc-tablewrapper">
|
|
|
|
|
<table class="doc-table">
|
|
|
|
|
<thead>
|
|
|
|
|
<tr>
|
|
|
|
|
<th>Key</th>
|
|
|
|
|
<th>Function</th>
|
|
|
|
|
</tr>
|
|
|
|
|
</thead>
|
|
|
|
|
<tbody>
|
|
|
|
|
<tr>
|
|
|
|
|
<td><i>enter</i></td>
|
|
|
|
|
<td>Closes the popup and moves focus to the multiselect element.</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td><i>space</i></td>
|
|
|
|
|
<td>Closes the popup and moves focus to the multiselect element.</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td><i>escape</i></td>
|
|
|
|
|
<td>Closes the popup and moves focus to the multiselect element.</td>
|
|
|
|
|
</tr>
|
|
|
|
|
</tbody>
|
|
|
|
|
</table>
|
|
|
|
|
</div>
|
|
|
|
|
</DocSectionText>
|
|
|
|
|
</template>
|
|
|
|
|
|
|
|
|
|
<script>
|
|
|
|
|
export default {
|
|
|
|
|
data() {
|
|
|
|
|
return {
|
|
|
|
|
code: {
|
|
|
|
|
basic: `
|
2023-02-28 17:40:48 +00:00
|
|
|
<span id="dd1"></span>Options</span>
|
|
|
|
|
<MultiSelect aria-labelledby="dd1" />
|
|
|
|
|
|
|
|
|
|
<MultiSelect aria-label="Options" />`
|
2023-02-28 08:29:30 +00:00
|
|
|
}
|
|
|
|
|
};
|
|
|
|
|
}
|
|
|
|
|
};
|
|
|
|
|
</script>
|
