Skip to content

Commit f778348

Browse files
committed
Add README and LICENSE
1 parent 79ba579 commit f778348

File tree

2 files changed

+118
-0
lines changed

2 files changed

+118
-0
lines changed

LICENSE

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
The MIT License (MIT)
2+
3+
Copyright (c) 2016-2020 - BootstrapVue
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

README.md

+97
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,97 @@
1+
# bootstrap-vue-timeline
2+
3+
## Introduction
4+
A timeline component similar to [Ant Timeline](https://www.antdv.com/components/timeline/) based on [Bootstrap-Vue](https://bootstrap-vue.org/).
5+
6+
## Demo
7+
8+
Link: TBD
9+
10+
## Usage
11+
12+
```html
13+
<script>
14+
import Vue from 'vue';
15+
import BootstrapVueTimeline from '@/bootstrap-vue-timeline.vue';
16+
import { BCard } from 'bootstrap-vue'
17+
Vue.component('b-card', BCard)
18+
19+
export default Vue.extend({
20+
name: 'ServeDev',
21+
components: {
22+
BootstrapVueTimeline
23+
},
24+
data() {
25+
return {
26+
timelineItems: [
27+
{
28+
timestamp: Date.parse('2021-05-29T20:20:46.444Z'),
29+
title: 'Dolore ullamco exercitation commodo',
30+
content: 'Esse dolore consectetur aliqua laboris sunt aliqua do non.',
31+
link: 'https://example1.com'
32+
},
33+
{
34+
timestamp: Date.parse('2021-05-28T20:20:46.444Z'),
35+
title: 'Voluptate pariatur dolore laborum eu',
36+
link: '#'
37+
},
38+
{
39+
timestamp: Date.parse('2021-01-28T20:20:46.444Z'),
40+
title: 'Mollit aliqua velit nostrud ipsum',
41+
content: 'Magna officia est fugiat sit esse consectetur labore elit nulla duis consectetur. Et sit velit ad ipsum officia.',
42+
link: '#'
43+
}
44+
]
45+
}
46+
}
47+
});
48+
</script>
49+
50+
<template>
51+
<div id="app">
52+
<b-card
53+
title="Event Timeline"
54+
>
55+
<bootstrap-vue-timeline
56+
:items="timelineItems"
57+
/>
58+
</b-card>
59+
</div>
60+
</template>
61+
```
62+
63+
## Features (WIP)
64+
- [ ] Loading spinner
65+
- [ ] Support item head color variants
66+
- [ ] Support `reverse` props
67+
- [ ] Support custom icons
68+
- [ ] Refactor timeline and item into separate components
69+
70+
## Component Reference
71+
### Properties
72+
TBD
73+
### Slots
74+
TBD
75+
### Events
76+
TBD
77+
78+
## Development
79+
80+
**Install dependencies**:
81+
```bash
82+
yarn install --dev
83+
```
84+
85+
**Run example app locally**:
86+
```bash
87+
yarn serve
88+
```
89+
90+
**Lints and fixes files**:
91+
```bash
92+
yarn lint
93+
```
94+
95+
## License
96+
97+
Released under the MIT [License](./LICENSE). Copyright (c) Bootstrap-vue-timeline.

0 commit comments

Comments
 (0)