@@ -14,19 +14,19 @@ https://www.w3.org/TR/WCAG20-TECHS/G124.html
14
14
## Install
15
15
#### NPM
16
16
``` shell
17
- npm install -S vue-skip-to
17
+ npm install -S @ vue-a11y/ skip-to
18
18
```
19
19
20
20
#### Yarn
21
21
``` shell
22
- yarn add vue-skip-to
22
+ yarn add @ vue-a11y/ skip-to
23
23
```
24
24
25
25
## How to use
26
26
In your ` main.js `
27
27
``` javascript
28
28
import Vue from ' vue'
29
- import VueSkipTo from ' vue-skip-to'
29
+ import VueSkipTo from ' @ vue-a11y/ skip-to'
30
30
31
31
Vue .use (VueSkipTo)
32
32
@@ -39,7 +39,7 @@ In your `App.vue`
39
39
``` vue
40
40
<template>
41
41
<div id="app">
42
- <vue-skip-to to="#main" text="Skip to main content" />
42
+ <VueSkipTo to="#main" text="Skip to main content" />
43
43
44
44
<logo :src="require('@/assets/logo.png')" />
45
45
<h1 data-va="main header">{{ msg }}</h1>
@@ -63,6 +63,9 @@ export default {
63
63
## Using with HTML files
64
64
``` html
65
65
<!-- omitted -->
66
+ <script src =" https://unpkg.com/vue" ></script >
67
+ <script src =" https://unpkg.com/@vue-a11y/skip-to" ></script >
68
+ </head >
66
69
<body >
67
70
<div id =" app" >
68
71
<vue-skip-to to =" #main" ></vue-skip-to >
@@ -74,14 +77,10 @@ export default {
74
77
</div >
75
78
</div >
76
79
77
- <script src =" https://unpkg.com/vue" ></script >
78
- <script src =" https://unpkg.com/vue-skip-to" ></script >
79
80
<script >
80
- Vue .use (VueSkipTo)
81
81
new Vue ({
82
82
el: " #app"
83
83
})
84
-
85
84
</script >
86
85
</body >
87
86
</html >
@@ -96,8 +95,6 @@ Prop | Data Type | required | Description | Default
96
95
--------------- | ---------- | --------- | ---------------------- | -------------
97
96
` to ` | String | false | Set destination ID | #main
98
97
` text ` | String | false | Text content of link | Skip to main content
99
- ` tabindex ` | String | false | Specifies the tab order | null
100
-
101
98
102
99
## Custom style
103
100
You can style the link through the selector ` .vue-skip-to `
@@ -113,25 +110,22 @@ http://www.nczonline.net/blog/2013/01/15/fixing-skip-to-content-links/
113
110
## Run the tests
114
111
115
112
``` shell
116
- git clone https://github.com/vue-a11y/vue-skip-to.git vue-skip-to
113
+ git clone https://github.com/vue-a11y/vue-skip-to.git
117
114
npm install
118
115
npm run dev
119
- npm run test
116
+ npm run test:e2e
120
117
```
121
118
122
119
Or run Cypress on interactive mode
123
120
``` shell
124
- npm run test:open
121
+ npm run test:e2e: open
125
122
```
126
123
127
- ## Roadmap
128
- https://github.com/vue-a11y/vue-skip-to/issues/1
129
-
130
124
## Contributing
125
+ - From typos in documentation to coding new features;
131
126
- Check the open issues or open a new issue to start a discussion around your feature idea or the bug you found;
132
127
- Fork repository, make changes and send a pull request;
133
128
134
- If you want a faster communication, find me on [ @ktquez ] ( https://twitter.com/ktquez )
135
- And follow us on Twitter [ @vue_a11y] ( https://twitter.com/vue_a11y )
129
+ Follow us on Twitter [ @vue_a11y] ( https://twitter.com/vue_a11y )
136
130
137
131
** Thank you**
0 commit comments