1.0.0 • Published 6 months ago

@josewmarinho/react-flip-clock v1.0.0

Weekly downloads
-
License
MIT
Repository
github
Last release
6 months ago

FlipClock

⏰ Um componente React com animação 3D para contagem regressiva (countdown) e contagem progressiva (countup).

Instalação

npm install --save @seupacote/flip-clock

ou

yarn add @seupacote/flip-clock

Uso Básico

import FlipClock from '@josewmarinho/flip-clock';
import '@josewmarinho/flip-clock/dist/index.css';

const App = () => (
  <FlipClock
    mode='up'
    from={new Date(2022, 4, 2, 23, 0, 0)}
    labels={['Anos', 'Meses', 'Dias', 'Horas', 'Minutos', 'Segundos']}
    digitBlockStyle={{
      width: 45,
      height: 65,
      fontSize: 32,
      borderRadius: 6,
      backgroundColor: '#ff007f',
      color: '#000000'
    }}
    dividerStyle={{ color: '#c2c2c2', height: 1 }}
    spacing={{ clock: 10, digitBlock: 4 }}
  >
    Tempo encerrado
  </FlipClock>
);

Principais Propriedades

PropriedadeTipoDescrição
mode"up" | "down"Define se a contagem será progressiva ou regressiva.
from / toDate | string | numberData inicial (from) ou final (to) da contagem.
labelsstring[]Rótulos exibidos nos dígitos (ex: ['Dias', 'Horas', ...]).
digitBlockStyleReact.CSSPropertiesEstilo dos blocos de dígitos (largura, altura, cor, fonte, etc).
dividerStyle{ color?: string; height?: any }Estilo da linha divisória entre os dígitos.
spacing{ clock?: number; digitBlock?: number }Espaçamento entre elementos.
durationnumberDuração da animação do flip (ex: 0.7).
childrenReactNodeConteúdo a ser renderizado quando a contagem termina.

Estilização via CSS

Você também pode personalizar o estilo globalmente usando variáveis CSS:

.flip-clock {
  --fcc-background: black;
  --fcc-digit-color: white;
  --fcc-label-color: #ccc;
  --fcc-flip-duration: 0.6s;
  --fcc-digit-block-width: 45px;
  --fcc-digit-block-height: 65px;
  --fcc-digit-font-size: 32px;
}

Licença

MIT © josewmarinho

1.0.0

6 months ago