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
+7-8
Original file line number
Diff line number
Diff line change
@@ -77,7 +77,8 @@ yarn add eagle.js
77
77
78
78
Eagle.js is a vue plugin. You need to `use` eagle.js in your vue app's main file.
79
79
<br>**New in 0.3**: `animate.css` is now a peer dependency. User need install their own version.
80
-
<br>**New in 0.6** You do not need to explicitly import the default style anymore.
80
+
<br>**New in 0.5**: By default eagle.js doesn't export all plugins but only core components. You have to explicitly use your widgets or plugins from now on. See more on [extensions section](https://github.com/Zulko/eagle.js#extensions).
81
+
<br>**New in 0.6**: You do not need to explicitly import the default style anymore.
81
82
82
83
```javascript
83
84
importEaglefrom'eagle.js'
@@ -87,8 +88,6 @@ import 'animate.css'
87
88
Vue.use(Eagle)
88
89
```
89
90
90
-
**New in 0.5.0** Now by default eagle.js doesn't export all plugins but only core components. You have to explicitly use your widgets or plugins from now on. See more on [extensions section](https://github.com/Zulko/eagle.js#extensions)
91
-
92
91
### Basic idea
93
92
94
93
Eagle.js's basic components are `slideshow` and `slide`. You use `slideshow` as mixin to write `slideshow` component, which could include multiple `slide`s. A very basic Single File Component for `slideshow` would look like this:
@@ -191,9 +190,9 @@ Under the hood, `eg-transition` is just vue's `transition` that supports [anima
191
190
192
191
## Extensions
193
192
194
-
Starting from 0.5.0 we introduction extensions to eagle.js. It includes two categories, namely widgets and plugins:
195
-
1. Widgets are Vue components that can be directly used in a slide.
196
-
2. Plugins are used in slideshow to enhance slide globally.
193
+
Starting from 0.5 we introduced extensions to eagle.js. It includes two categories, namely widgets and plugins:
194
+
1. Widgets are Vue components that can be directly used in a `slide`.
195
+
2. Plugins are used in `slideshow` to enhance `slide` globally.
197
196
198
197
Both widgets and plugins have the same interface to use, just like how Vue uses plugins, for example:
199
198
@@ -229,7 +228,7 @@ Eagle.use(CodeBlock)
229
228
Widgets' name follows the same rule: uppercase for importing, `eg` prefixed lowercase connected with dash in HTML.
230
229
See more of their usage in the [demo project](https://github.com/Zulko/eaglejs-demo).
231
230
232
-
*New in 0.3.0*: `highlight.js` is not a dependency anymore, so if you need to use `eg-code-block`, you need to install your own version of `highlight.js`, then specifiy it in your `main.js`:
231
+
*New in 0.3*: `highlight.js` is not a dependency anymore, so if you need to use `eg-code-block`, you need to install your own version of `highlight.js`, then specifiy it in your `main.js`:
233
232
234
233
```javascript
235
234
// import your own highlight.js(only for javascript)
@@ -388,7 +387,7 @@ Intuitively, writing your `slide` components and then using Vue's [async compon
388
387
389
388
## Frequently Asked Questions
390
389
391
-
-### (Vue-CLI v.4+) The white-spaces in my code are not preserved by the CodeBlock widget, how can I fix it?
390
+
-####(Vue-CLI v.4+) The white-spaces in my code are not preserved by the CodeBlock widget, how can I fix it?
392
391
393
392
The way Vue-CLI treats white-spaces [has changed](https://cli.vuejs.org/migrating-from-v3/#vue-cli-service) in the version 4. If you use Vue-CLI to create your slideshow, you will need to add the following configuration in your `vue.config.js` file (see [issue#90](https://github.com/Zulko/eagle.js/issues/90#issue-510662591)).
0 commit comments