Rollex



Versatile counters in React

Installation

Install with yarn:

``sh
yarn add rollex


or npm:


npm i -S rollex
`

Usage

1. Import Counter component:

`js
import { Counter } from 'rollex'
`

2. Use it:

`jsx

`

API

$3

There are multiple ways of setting the time interval to count down (or up) to:

You can tell Rollex how many seconds to count:
`jsx

`

Or, you can specify timestamps to count to (and from):

`jsx
// from now to a given timestamp

// from from to to

`

$3


By default, Rollex counters update every second. You can, however, set your own update period via
interval prop:

`jsx
// update every 2 seconds

`

$3

By default, Rollex counters count "down" (from, say, 60 down to 0). You can make a counter go up:

`jsx
// from 0 to 60

`

$3

Rollex counters are split into periods (days, hours, minutes, seconds). Each period has its own
segment, which contains the digits which correspond to a given period.

By default, Rollex counters use four periods: "days", "hours", "minutes", "seconds" and each segment
is exactly 2 digits long.

You can control this behaviour:

`jsx
// show only hours and minutes

// show 3 digits per segment

`

$3

You can temporarily (or not) freeze the counter by passing it a frozen prop:

`jsx

`

When frozen is truthy, the counter will not update at all.

$3

By default, Rollex counters do not try to synchronize time. That means that if a counter is frozen
at 59 seconds, and then unfrozen after an hour, it will continue counting down from 59 seconds.
If time sync is enabled, the counter will synchronize time and instantly go down to 0.

`jsx

`

$3


By default, Rollex counters are not animated (they look like digital clocks). If you want to enable
animations (make the counters look analog), you should pass the easingFunction prop (any valid
CSS easing function):

`jsx

`

You can also control animation duration (300 ms by default):

`jsx

`

$3

You can even control the radix that Rollex counters use! By default it's 10, but if you want to
go dozenal, you can:

`jsx

`

$3

If you want to use different symbols for your digits, you can (let's say, you want a dozenal
counter with 'X' representing a 10 and 'E' representing an 11):

`jsx
'A': 'X',
'B': 'E',
}} />
`

You can get even more control over your digits with a digit map:

`jsx
// use images instead of text for digits
seconds={3600}
digitWrapper={digit => /digits/${digit}.jpg} />}
/>
`

$3

All counter segments can be labelled.

`jsx
// map from periods to strings
days: 'days',
hours: 'hours'
}} />
// use a function (use case: pluralisation)
{
return number % 10 === 1 ? period.slice(0, -1) : period
}}>
`

Segments can be separated by a separator symbol:

`jsx
// dd:hh:mm:ss

``