https://github.com/pablopunk/react-simple-timeline
Simple and responsive timeline component for React
https://github.com/pablopunk/react-simple-timeline
Last synced: about 1 year ago
JSON representation
Simple and responsive timeline component for React
- Host: GitHub
- URL: https://github.com/pablopunk/react-simple-timeline
- Owner: pablopunk
- Created: 2018-01-16T17:09:59.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2023-03-01T13:31:32.000Z (over 3 years ago)
- Last Synced: 2024-05-02T05:12:19.019Z (about 2 years ago)
- Language: JavaScript
- Size: 377 KB
- Stars: 4
- Watchers: 3
- Forks: 1
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# react-simple-timeline
Simple and responsive timeline component for React
## Install
```sh
npm install react-simple-timeline
```
## Usage
```js
import Timeline from 'react-simple-timeline'
//...
Dwigth Schrute
```
### Options
* Fade
For a beautiful animation, use the prop `fade`. It will fade in each element, in order.
```jsx
```
## Contribute
Clone the repo and create a simple react project where you use this component:
```sh
$ cd your-project/ # Your project folder
$ npm install react-simple-timeline # Install dep
$ npm link ../path/to/component/repo # Link the cloned repo
$ cd ../path/to/component/repo # This repo folder
$ npm run dev # Build and watch for changes
```
Make your changes and run the tests:
```sh
$ npm test
```
Now you're ready to make the Pull Request.
## License
MIT
## Author
|  |
| --------------------------------- |
| [Pablo Varela](https://pablo.life) |