Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/morkro/vue-a11y-dialog
Vue.js component for a11y-dialog
https://github.com/morkro/vue-a11y-dialog
a11y a11y-dialog accessibility dialog portal portal-vue vue
Last synced: 5 days ago
JSON representation
Vue.js component for a11y-dialog
- Host: GitHub
- URL: https://github.com/morkro/vue-a11y-dialog
- Owner: morkro
- License: mit
- Created: 2018-06-11T08:51:18.000Z (over 6 years ago)
- Default Branch: main
- Last Pushed: 2023-07-18T20:54:23.000Z (over 1 year ago)
- Last Synced: 2024-06-11T17:21:47.876Z (5 months ago)
- Topics: a11y, a11y-dialog, accessibility, dialog, portal, portal-vue, vue
- Language: Vue
- Homepage: https://www.npmjs.com/package/vue-a11y-dialog
- Size: 897 KB
- Stars: 94
- Watchers: 3
- Forks: 13
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
- awesome-a11y-vue - vue-a11y-dialog - Vue.js wrapper for `a11y-dialog` . (Components and plugins / Courses)
- awesome-access - vue-a11y-dialog - Vue.js wrapper for `a11y-dialog` . (Components and plugins / Courses)
README
# Vue A11yDialog [](https://travis-ci.org/morkro/vue-a11y-dialog)
This is a Vue.js wrapper component for [`[email protected]`](https://github.com/KittyGiraudel/a11y-dialog) ([**Demo on CodeSandbox**](https://codesandbox.io/s/rj20wr1kpp)).
- [Installation](#installation)
- [Usage](#usage)
- [Multiple dialogs](#multiple-dialogs)
- [API](#api)
- [Events](#events)
- [Slots](#slots)
- [Server-side Rendering](#server-side-rendering)
## Installation
This library supports both Vue 3 and Vue 2. However, active maintenance is focused on Vue 3. If you still need to support Vue 2, you can stay on version [`0.5.2`](https://github.com/morkro/vue-a11y-dialog/tree/0.5.2).
**Vue 3**
```bash
npm install vue-a11y-dialog
```
**Vue 2**
```bash
npm install [email protected]
```
## Usage
In your `main.js` application file, install the component:
```js
import { createApp } from 'vue'
import A11yDialog from 'vue-a11y-dialog'
import App from './App.vue'
createApp(App).use(A11yDialog).mount('#app')
```
Then use it as follows:
```html
Open dialog
Your dialog title
Your content
```
```js
export default {
name: 'YourComponent',
data: () => ({
dialog: null
}),
methods: {
openDialog() {
if (this.dialog) {
this.dialog.show()
}
},
assignDialogRef(dialog) {
this.dialog = dialog
}
}
}
```
It's important to assign the direct reference to the dialog instance via `@dialog-ref`, otherwise there is no way to call its methods.
Alternatively, you can also import the component directly into your file without installing it first:
```js
import { A11yDialog } from 'vue-a11y-dialog'
export default {
name: 'YourComponent',
components: {
'a11y-dialog': A11yDialog
},
methods: {
// ...
}
}
```
### Multiple dialogs
It's possible to use multiple dialogs in the same component, just make sure to assign the different `dialog` instances separately.
In your ``:
```html
assignDialogRef('first', dialog)"
>
First dialog title
Your content
assignDialogRef('second', dialog)"
>
Second dialog title
Your content
```
In your ``:
```js
import { A11yDialog } from 'vue-a11y-dialog';
export default {
name: 'YourComponent',
data: () => ({
dialogs: {}
}),
methods: {
assignDialogRef(type, dialog) {
this.dialogs[type] = dialog
}
}
}
```
## API
> All `a11y-dialog` instance methods are available, for further documentation see [here](https://a11y-dialog.netlify.app/).
### `id`
- **Property**: `id`
- **Type**: `String`
- **Required**: `true`
- **Description**: The unique HTML `id` attribute added to the dialog element, internally used by a11y-dialog to manipulate the dialog.
- **Usage**:
```html
<a11y-dialog id="main-dialog">
<!-- ... -->
</a11y-dialog>
```
### `dialog-root`
- **Property**: `dialog-root`
- **Type**: `String` — CSS Selector string.
- **Required**: `false`
- **Default**: `'body'`
- **Description**: The container for the dialog to be rendered into.
- **Usage**:
```html
<a11y-dialog dialog-root="#dialog-root">
<!-- ... -->
</a11y-dialog>
```
### `class-names`
- **Property**: `class-names`
- **Type**: `Object`
- **Required**: `false`
- **Default**: `{}`
- **Description**: Object of classes for each HTML element of the dialog element. Keys are: `container`, `overlay`, `document`, `title`, `closeButton`. See [a11y-dialog docs](https://a11y-dialog.netlify.app/usage/markup) for reference.
- **Usage**:
```html
<a11y-dialog :class-names="{ container: 'container-class', overlay: 'overlay-class' }">
<!-- ... -->
</a11y-dialog>
```
### `title-id`
- **Property**: `title-id`
- **Type**: `String`
- **Required**: `false`
- **Default**: Defaults to `id + '-title'`.
- **Description**: The HTML `id` attribute of the dialog’s title element, used by assistive technologies to provide context and meaning to the dialog window.
- **Usage**:
```html
<a11y-dialog title-id="main-title">
<!-- ... -->
</a11y-dialog>
```
### `close-button-label`
- **Property**: `close-button-label`
- **Type**: `String`
- **Required**: `false`
- **Default**: `'Close this dialog window'`
- **Description**: The HTML `aria-label` attribute of the close button, used by assistive technologies to provide extra meaning to the usual cross-mark.
- **Usage**:
```html
<a11y-dialog close-button-label="Close dialog">
<!-- ... -->
</a11y-dialog>
```
### `role`
- **Property**: `role`
- **Type**: `String`
- **Required**: `false`
- **Default**: `dialog`
- **Description**: The `role` attribute of the dialog element, either `dialog` (default) or `alertdialog` to make it a modal (preventing closing on click outside of <kbd>ESC</kbd> key).
- **Usage**:
```html
<a11y-dialog role="alertdialog">
<!-- ... -->
</a11y-dialog>
```
## Events
### `dialog-ref`
- **Returns**: An `a11y-dialog` instance or `undefined`.
- **Description**: This event emits the `a11y-dialog` instance once the component has been initialised. When it gets `destroyed`, the event returns `undefined`. This is needed to call instance methods of the dialog, e.g. `this.dialog.show()`.
- **Usage**:
```html
<a11y-dialog @dialog-ref="assignDialogRef">
<!-- ... -->
</a11y-dialog>
```
```js
export default {
// ...
methods: {
assignDialogRef(dialog) {
this.dialog = dialog
}
}
}
```
## Slots
### `title`
- **Name**: `title`
- **Description**: The title of the dialog, mandatory in the document to provide context to assistive technology. Could be [hidden with CSS](https://hugogiraudel.com/2016/10/13/css-hide-and-seek/) (while remaining accessible).
- **Usage**:
```html
<a11y-dialog>
<template v-slot:title>
<span>Your dialog title</span>
</template>
<!-- ... -->
</a11y-dialog>
```
### `closeButtonContent`
- **Name**: `closeButtonContent`
- **Default**: `\u00D7` (×)
- **Description**: The string that is the inner HTML of the close button.
- **Usage**:
```html
<a11y-dialog>
<template v-slot:closeButtonContent>
<span>Close dialog</span>
</template>
<!-- ... -->
</a11y-dialog>
```
### `closeButtonPosition`
- **Name**: `closeButtonPosition`
- **Default**: `first`
- **Description**: One of `first`, `last`, or `none`
- **Usage**:
```html
<a11y-dialog close-button-position="last">
<template v-slot:closeButtonContent>
<span>Close dialog</span>
</template>
<!-- ... -->
</a11y-dialog>
```
## Server-side Rendering
This is a client-only component; `a11y-dialog` won't render anything on the server and wait for your bundle to be executed on the client.