You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+3-85Lines changed: 3 additions & 85 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -32,9 +32,9 @@ Use specific components:
32
32
33
33
```javascript
34
34
importVuefrom'vue'
35
-
import { Test } from'vue-typed-js'
35
+
import { VueTypedJs } from'vue-typed-js'
36
36
37
-
Vue.component('test', Test)
37
+
Vue.component('vue-typed-js', VueTypedJs)
38
38
```
39
39
40
40
**⚠️ A css file is included when importing the package. You may have to setup your bundler to embed the css in your page.**
@@ -50,17 +50,6 @@ import VueTypedJs from 'vue-typed-js/dist/vue-typed-js.common'
50
50
Vue.use(VueTypedJs)
51
51
```
52
52
53
-
Use specific components:
54
-
55
-
```javascript
56
-
import'vue-typed-js/dist/vue-typed-js.css'
57
-
import { Test } from'vue-typed-js/dist/vue-typed-js.common'
58
-
59
-
Vue.component('test', Test)
60
-
```
61
-
62
-
**⚠️ You may have to setup your bundler to embed the css file in your page.**
63
-
64
53
## Browser
65
54
66
55
```html
@@ -78,12 +67,6 @@ Install all the components:
78
67
Vue.use(VueTypedJs)
79
68
```
80
69
81
-
Use specific components:
82
-
83
-
```javascript
84
-
Vue.component('test', VueTypedJs.Test)
85
-
```
86
-
87
70
## Source import
88
71
89
72
Install all the components:
@@ -95,17 +78,6 @@ import VueTypedJs from 'vue-typed-js/src'
95
78
Vue.use(VueTypedJs)
96
79
```
97
80
98
-
Use specific components:
99
-
100
-
```javascript
101
-
importVuefrom'vue'
102
-
import { Test } from'vue-typed-js/src'
103
-
104
-
Vue.component('test', Test)
105
-
```
106
-
107
-
**⚠️ You need to configure your bundler to compile `.vue` files.** More info [in the official documentation](https://vuejs.org/v2/guide/single-file-components.html).
108
-
109
81
# Usage
110
82
111
83
> TODO
@@ -116,60 +88,6 @@ Vue.component('test', Test)
116
88
117
89
---
118
90
119
-
# Plugin Development
120
-
121
-
## Installation
122
-
123
-
The first time you create or clone your plugin, you need to install the default dependencies:
124
-
125
-
```
126
-
npm install
127
-
```
128
-
129
-
## Watch and compile
130
-
131
-
This will run webpack in watching mode and output the compiled files in the `dist` folder.
132
-
133
-
```
134
-
npm run dev
135
-
```
136
-
137
-
## Use it in another project
138
-
139
-
While developping, you can follow the install instructions of your plugin and link it into the project that uses it.
140
-
141
-
In the plugin folder:
142
-
143
-
```
144
-
npm link
145
-
```
146
-
147
-
In the other project folder:
148
-
149
-
```
150
-
npm link vue-typed-js
151
-
```
152
-
153
-
This will install it in the dependencies as a symlink, so that it gets any modifications made to the plugin.
154
-
155
-
## Publish to npm
156
-
157
-
You may have to login to npm before, with `npm adduser`. The plugin will be built in production mode before getting published on npm.
158
-
159
-
```
160
-
npm publish
161
-
```
162
-
163
-
## Manual build
164
-
165
-
This will build the plugin into the `dist` folder in production mode.
0 commit comments