@rooks/use-time-ago
v4.11.2
Published
A React Hook to get time ago for timestamp millisecond value
Downloads
519
Maintainers
Readme
@rooks/use-time-ago
Note: Future updates to this package have moved to the main package rooks. All hooks now reside in a single package which you can install using
npm install rooks
or
yarn add rooks
Rooks is completely treeshakeable and if you use only 1 of the 50+ hooks in the package, only that hook will be bundled with your code. Your bundle will only contain the hooks that you need. Cheers!
About
A React Hook to get time ago for timestamp millisecond value.
Installation
npm install --save @rooks/use-time-ago
Importing the hook
import useTimeAgo from "@rooks/use-time-ago"
Usage
function Demo() {
const [date, setDate] = useState(new Date());
const timeAgo = useTimeAgo(date.getTime() - 1000 * 12, {
locale: "zh_CN"
});
const timeAgo2 = useTimeAgo(date.getTime() - 1000 * 12);
return (
<>
<p>{timeAgo}</p>
<p>{timeAgo2}</p>
</>
);
}
render(<Demo/>)
Arguments
| Argument | Type | Description | Default value | | -------- | ------ | -------------- | ------------------ | | input | Date | Timestamp | etc | Any input that time-ago.js supports | undefined | | options | Object | Options object | { intervalMs:0 } |
Options
| Options | Type | Description | Default value | | ------------ | ------------ | ---------------------------------------------------------------------- | ------------- | | intervalMs | milliseconds | Duration after which time-ago has to be calculated | 1000 | | locale | String | Locale in which value is expected | undefined | | relativeDate | Date | Relative date object with respect to which time-ago is to be calcuated | Current Time |
Returned Value
Timeago string is returned.