2023-02-28 08:29:30 +00:00
|
|
|
<template>
|
|
|
|
<DocSectionText id="accessibility" label="Accessibility" v-bind="$attrs">
|
|
|
|
<h3>Screen Reader</h3>
|
|
|
|
<p>
|
|
|
|
Checkbox component uses a hidden native checkbox element internally that is only visible to screen readers. Value to describe the component can either be provided via <i>label</i> tag combined with <i>inputId</i> prop or using
|
|
|
|
<i>aria-labelledby</i>, <i>aria-label</i> props.
|
|
|
|
</p>
|
|
|
|
|
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>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 checkbox.</td>
|
|
|
|
</tr>
|
|
|
|
<tr>
|
|
|
|
<td><i>space</i></td>
|
|
|
|
<td>Toggles the checked state.</td>
|
|
|
|
</tr>
|
|
|
|
</tbody>
|
|
|
|
</table>
|
|
|
|
</div>
|
|
|
|
</DocSectionText>
|
|
|
|
</template>
|
|
|
|
|
|
|
|
<script>
|
|
|
|
export default {
|
|
|
|
data() {
|
|
|
|
return {
|
|
|
|
code: {
|
2023-08-16 13:58:31 +00:00
|
|
|
basic: `<label for="chkbox1">Remember Me</label>
|
2023-02-28 08:29:30 +00:00
|
|
|
<Checkbox inputId="chkbox1" />
|
|
|
|
|
|
|
|
<span id="chkbox2">Remember Me</span>
|
|
|
|
<Checkbox aria-labelledby="chkbox2" />
|
|
|
|
|
|
|
|
<Checkbox aria-label="Remember Me" />`
|
|
|
|
}
|
|
|
|
};
|
|
|
|
}
|
|
|
|
};
|
|
|
|
</script>
|