Skip to content

Commit ae782e9

Browse files
committed
update version, readme and add .npmignore
1 parent b01c175 commit ae782e9

File tree

3 files changed

+34
-12
lines changed

3 files changed

+34
-12
lines changed

.npmignore

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
build
2+
dev
3+
node_modules
4+
babel.config.js

README.md

Lines changed: 29 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -16,22 +16,40 @@ yarn add vue-onoff-toggle
1616
```
1717

1818

19-
## How to use
19+
## Import in Vue.js
20+
In your `main.js` file:
21+
2022
```javascript
23+
import Vue from 'vue'
2124
import OnoffToggle from 'vue-onoff-toggle'
2225

23-
new Vue({
24-
components: {
25-
OnoffToggle
26-
},
27-
data() {
28-
return {
29-
checked: false
30-
}
31-
}
32-
})
26+
Vue.use(OnoffToggle)
3327
```
3428

29+
## Import in Nuxt.js
30+
Create a new plugin in `plugins/vue-onoff-toggle.js`:
31+
32+
```javascript
33+
import Vue from 'vue'
34+
import OnoffToggle from 'vue-onoff-toggle'
35+
36+
Vue.use(OnoffToggle)
37+
```
38+
39+
Add this new plugin to `nuxt.config.js`
40+
41+
```javascript
42+
module.exports = {
43+
// ...
44+
plugins: [
45+
// ...
46+
'~plugins/vue-onoff-toggle'
47+
]
48+
}
49+
```
50+
51+
## How to use
52+
After import, use `onoff-toggle` tag inside your vue template:
3553
```html
3654
<onoff-toggle v-model="checked" />
3755

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "vue-onoff-toggle",
3-
"version": "1.0.6",
3+
"version": "1.1.0",
44
"description": "A smart, lightweight and easy-to-use on/off toggle component for Vue.js with multiple themes.",
55
"main": "dist/vue-onoff-toggle.ssr.js",
66
"browser": "dist/vue-onoff-toggle.esm.js",

0 commit comments

Comments
 (0)