Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/wrathchaos/react-native-beautiful-timeline
Fully customizable, beautifully designed Timeline for React Native.
https://github.com/wrathchaos/react-native-beautiful-timeline
android apple calendar freakycoder google ios javascript kuray library mobile mobile-application-development react react-native reactjs timeline timeline-component
Last synced: 7 days ago
JSON representation
Fully customizable, beautifully designed Timeline for React Native.
- Host: GitHub
- URL: https://github.com/wrathchaos/react-native-beautiful-timeline
- Owner: WrathChaos
- License: mit
- Created: 2019-11-20T15:16:11.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2023-10-21T01:07:21.000Z (about 1 year ago)
- Last Synced: 2024-11-21T19:51:07.615Z (about 1 month ago)
- Topics: android, apple, calendar, freakycoder, google, ios, javascript, kuray, library, mobile, mobile-application-development, react, react-native, reactjs, timeline, timeline-component
- Language: Java
- Homepage: https://freakycoder.com
- Size: 8.58 MB
- Stars: 235
- Watchers: 4
- Forks: 33
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://github.com/WrathChaos/react-native-beautiful-timeline)
[](https://github.com/WrathChaos/react-native-beautiful-timeline)
[](https://www.npmjs.com/package/react-native-beautiful-timeline)
[](https://www.npmjs.com/package/react-native-beautiful-timeline)
[](https://opensource.org/licenses/MIT)
[](https://github.com/prettier/prettier)
# Installation
Add the dependency:
```ruby
npm i react-native-beautiful-timeline
```
## Peer Dependencies
###### IMPORTANT! You need install them
```js
"moment": ">= 2.24.0",
"react-native-dash-2": ">= 0.2.3",
"react-native-androw" : ">= 0.0.34",
"@freakycoder/react-native-helpers": ">= 0.1.0",
```
# Usage
## Import
```js
import Timeline from "react-native-beautiful-timeline";
```
## Basic Usage
### Data Format
The data format MUST like this example.
```json
[
{
"date": 1574342522000,
"data": [
{
"title": "React Native Beautiful Timeline",
"subtitle": "Sed at justo eros. Phasellus.",
"date": 1574342522000
},
{
"title": "React Native",
"subtitle": "Sed viverra. Nam sagittis.",
"date": 1574342501000
}
]
},
{
"date": 1574248261000,
"data": [
{
"title": "Timeline",
"subtitle": "Morbi magna orci, consequat in.",
"date": 1574248261000
}
]
},
{
"date": 1574125621000,
"data": [
{
"title": "Beauty Timeline",
"subtitle": "Nulla a eleifend urna. Morbi. Praesent.",
"date": 1574125621000
}
]
}
]
```
#### Let's take a look a bit closer:
For each day & there would be limitless objects(Cards) for each day something like this example:
Each card comes from `data` array and each **day** comes from each `object` from main array.
```json
{
"date": 1574342522000,
"data": [
{
"title": "React Native Beautiful Timeline",
"subtitle": "Sed at justo eros. Phasellus.",
"date": 1574342522000
},
{
"title": "React Native",
"subtitle": "Sed viverra. Nam sagittis.",
"date": 1574342501000
}
]
}
```
## Basic Usage
Please take a look at above data formatting. Library itself solves everything for you if the data format is correct.
```jsx
```
## Configuration - Props
### Coming Soon !
## Future Plans
- [x] ~~LICENSE~~
- [x] ~~README: Better Example Image~~
- [x] ~~README: GIF Asset~~
- [x] ~~README: Data Formatting~~
- [x] ~~Configuration: Props~~
- [x] ~~Version 1~~
- [ ] Without Card Feature Data Formatting Implementation (Coming soon!)
- [ ] Write an article about the lib on Medium
## Credits
Thank you for this awesome inspiration. Designed by [Kamil Janus](https://dribbble.com/shots/3934981-Calendar-view-of-concept-financial-app)
## Author
FreakyCoder, [email protected]
## License
React Native Beautiful Timeline is available under the MIT license. See the LICENSE file for more info.