https://github.com/chalarangelo/timy
A simple time ago React component.
https://github.com/chalarangelo/timy
Last synced: 2 months ago
JSON representation
A simple time ago React component.
- Host: GitHub
- URL: https://github.com/chalarangelo/timy
- Owner: Chalarangelo
- License: mit
- Created: 2019-06-20T15:12:23.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2019-06-20T16:44:52.000Z (almost 6 years ago)
- Last Synced: 2025-03-23T06:25:02.469Z (2 months ago)
- Language: JavaScript
- Size: 8.79 KB
- Stars: 3
- Watchers: 1
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# react-timy
A simple *time ago* React component.
### Features
- Tiny (under 3KB).
- Easy to customize (see below).
- Updates automatically over time.
### Installation
```sh
npm i react-timy
```
### Usage
```jsx
ReactDOM.render(, document.getElementById('root'));
```
### API
#### Timy
`` is the component that renders the *time ago* text on your screen. It takes two arguments:
- `date`: a `Date` object that is used to calculate the *time ago* text. - Default: `new Date()` at the time of creation.
- `config`: an object with the string values required for rendering the *time ago* text. - Default: `formatConfig` (see below).
#### formatConfig
`formatConfig` is an object with all the strings required for rendering the *time ago* text. It contains the following key-value pairs:
```js
{
justNow: 'Just now',
aFewSecondsAgo: 'A few seconds ago',
secondsAgo: 'seconds ago',
aMinuteAgo: 'A minute ago',
minutesAgo: 'minutes ago',
anHourAgo: 'An hour ago',
hoursAgo: 'hours ago',
aDayAgo: 'A day ago',
daysAgo: 'days ago',
aWeekAgo: 'A week ago',
weeksAgo: 'weeks ago',
aMonthAgo: 'A month ago',
monthsAgo: 'months ago',
aYearAgo: 'A year ago',
yearsAgo: 'years ago'
}
```
You can create your own configuration object and use it with the `` component. Remember to provide a string for each one of the values mentioned above.
---
`react-timy` is licensed under the **MIT License**.