https://github.com/LeCoupa/vuetimeline
🕵️♀️🕵️♂️ One easy-to-use component for Vue.js to build beautiful responsive timelines.
https://github.com/LeCoupa/vuetimeline
component nuxtjs vuejs vuetimeline
Last synced: 4 months ago
JSON representation
🕵️♀️🕵️♂️ One easy-to-use component for Vue.js to build beautiful responsive timelines.
- Host: GitHub
- URL: https://github.com/LeCoupa/vuetimeline
- Owner: LeCoupa
- License: mit
- Created: 2019-11-06T16:55:45.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2022-12-30T19:31:55.000Z (over 2 years ago)
- Last Synced: 2024-10-30T00:43:51.446Z (8 months ago)
- Topics: component, nuxtjs, vuejs, vuetimeline
- Language: SCSS
- Homepage: https://www.growthbunker.dev/vuetimeline
- Size: 1.33 MB
- Stars: 349
- Watchers: 5
- Forks: 44
- Open Issues: 24
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://www.npmjs.com/package/@growthbunker/vuetimeline)
[](https://npm-stat.com/charts.html?package=@growthbunker/vuetimeline)
[](http://isitmaintained.com/project/growthbunker/vuetimeline "Average time to resolve an issue")
[](http://isitmaintained.com/project/growthbunker/vuetimeline "Percentage of issues still open")
[](https://github.com/growthbunker/vuetimeline/blob/master/LICENSE)
[](https://app.netlify.com/sites/growthbunker/deploys)
## Documentation
You can browse the documentation for Vue Timeline [on the website](https://www.growthbunker.dev/vuetimeline).
## Installation
```
npm install @growthbunker/vuetimeline
# Or if you prefer using yarn
yarn add @growthbunker/vuetimeline
```
### Vue.js
In your `main.js` file:
```js
import Vue from "vue"
import vuetimeline from "@growthbunker/vuetimeline"
Vue.use(vuetimeline)
```
### Nuxt.js
Create a new plugin in `plugins/vuetimeline.js`:
```js
import Vue from "vue"
import vuetimeline from "@growthbunker/vuetimeline"
Vue.use(vuetimeline)
```
Add this new plugin to `nuxt.config.js`.
```js
module.exports = {
// ...
plugins: [{ src: "@/plugins/vuetimeline.js" }];
}
```
### CDN
Get the latest version from [jsdelivr](https://www.jsdelivr.com/), and import the JavaScript file in your page.
```html
```
We recommend our users to lock Vue Timeline's version when using CDN. Requesting the latest version (as opposed to "latest major" or "latest minor") is dangerous because major versions usually come with breaking changes. Only do this if you really know what you are doing. [Please refer to jsdelivr.com](https://www.jsdelivr.com/features) for more information.
## Example
Once the plugin is installed, you can use the component like this:
```html
```
## Contributing
You are more than welcome to contribute to Vue Timeline. Just submit changes via pull request and I will review them before merging.
1. Fork it! 🤙
2. Create your feature branch: `git checkout -b my-new-feature`
3. Commit your changes: `git commit -am "Add some feature"`
4. Push to the branch: `git push origin my-new-feature`
5. Submit a pull request 👍
The documentation is available in the `docs` folder. The Vue Timeline components are available in the `lib` folder.
## License
Vue Timeline is [MIT licensed](LICENSE).