Getting Started

Installation

Package Manager

Package manager like pnpm, yarn, npm, etc.

pnpm

pnpm i flipclock

yarn

yarn add flipclock

npm

npm i flipclock

bun

bun i flipclock

CDN

JSDelivr

<script src="https://cdn.jsdelivr.net/npm/flipclock@^1/dist/FlipClock.umd.js"></script>

Unpkg

<script src="https://unpkg.com/flipclock@^1/dist/FlipClock.umd.js"></script>

Basic Example

import { clock, css, flipClock, theme } from 'flipclock';

const parent = document.querySelector('#clock')!;

flipClock({
    parent,
    face: clock(),
    theme: theme({
        dividers: ':',
        css: css({
            fontSize: '3rem'
        })
    })
});