Skip to content

Commit 92eb068

Browse files
committed
Doc: Update name package
1 parent 3e9b618 commit 92eb068

File tree

4 files changed

+7
-7
lines changed

4 files changed

+7
-7
lines changed

docs/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
Imagine browsing pages (routes), receiving alerts and notifications, having a countdown timer on the page, a progress bar, a loading or a change of route in a SPA. Now imagine all this happening to people who have visual disabilities and who use screen readers.
44

5-
The [vue-announcer](https://github.com/vue-a11y/vue-announcer) provides an easy way to really tell what’s going on in your application to people using screen readers.
5+
The [@vue-a11y/announcer](https://github.com/vue-a11y/vue-announcer) provides an easy way to really tell what’s going on in your application to people using screen readers.
66

77
Inspired by others in the community like:
88
- [Example of how creating an accessible single-page application](https://haltersweb.github.io/Accessibility/spa.html)

docs/guide/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,19 +4,19 @@
44

55
#### NPM
66
```shell
7-
npm install -S vue-announcer
7+
npm install -S @vue-a11y/announcer
88
```
99

1010
#### Yarn
1111
```shell
12-
yarn add vue-announcer
12+
yarn add @vue-a11y/announcer
1313
```
1414

1515
## Basic usage
1616

1717
```javascript
1818
import Vue from 'vue'
19-
import VueAnnouncer from 'vue-announcer'
19+
import VueAnnouncer from '@vue-a11y/announcer'
2020

2121
Vue.use(VueAnnouncer)
2222
```

docs/guide/accessibility.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ It is used in most situations that present new information to users.
1212
The notification will take place at the next available point, without interruptions.
1313

1414
::: tip Note
15-
In the [vue-announcer plugin](https://github.com/vue-a11y/vue-announcer/blob/master/src/index.js#L8) the default is `polite`
15+
In the [@vue-a11y/announcer plugin](https://github.com/vue-a11y/vue-announcer/blob/master/src/index.js#L8) the default is `polite`
1616
:::
1717

1818
### assertive

docs/guide/announcer-router.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ For page changes (routes) to be announced automatically, you only need to pass t
77
```javascript
88
import Vue from 'vue'
99
import router from './router'
10-
import VueAnnouncer from 'vue-announcer'
10+
import VueAnnouncer from '@vue-a11y/announcer'
1111

1212
Vue.use(VueAnnouncer, {}, router)
1313
```
@@ -79,7 +79,7 @@ Key | Data Type | data | default
7979

8080
::: tip Note
8181
- The plug-in checks whether the message to be announced has been defined in the meta.announcer object, otherwise the document title to be loaded will be announced.
82-
- The vue-announcer uses the global after hooks `router.afterEach` to announce the route changes.
82+
- The @vue-a11y/announcer uses the global after hooks `router.afterEach` to announce the route changes.
8383
:::
8484

8585
## Skip in specific route

0 commit comments

Comments
 (0)