Giter VIP home page Giter VIP logo

react-top-progress's Introduction

react-top-progress

Uma simples barra de progresso reutilizável para ReactJs, que simula o comportamento do loading (fake) do Youtube e também o progresso de leitura usado em blogs, como Alligator.io.

Como utilizar

A lib export 3 componentes atualmente, e você pode importá-los dessa maneira:

import TopProgress, { ScrollProgress, FakeProgress } from './components/TopProgress';

Após o import, você pode utilizar os componentes dessa forma:

 <FakeProgress
  isComplete={isFinished}
  onComplete={() => console.log('completado')}
  pauseUntillComplete
/>
... ou ...
<ScrollProgress />

Props Comuns

Nome Valor Padrão Tipo Detalhes
containerStyles undefined object Define estilos personalizados para o plano de fundo da barra
progressLevelStyles undefined object Define estilos personalizados para o nível de progresso da barra
progress 0 number Define a porcentagem atual da barra. Surtirá efeito apenas no componente base: TopProgress
isGradient false Boolean Define se o gradiente deve ser aplicado ao nível de progresso
smooth false Boolean Define se a transição entre os níveis de progresso da barra devem ser suaves
animateGradient true Boolean Define se o gradiente deve ser animado
gradientColors array ['red', 'yellow', 'green', 'blue', 'purple'] Definição das cores que serão aplicadas ao gradiente do nível de progresso. NOTA: Esse array precisa ter um tamanho (length) igual a 5, do contrário o gradiente não será aplicado!

FakeProgress Props

Nome Valor Padrão Tipo Detalhes
isComplete false boolean Caso seja passada com valor true, esse Boolean fará com que a barra tenha seu valor setado para 100% e chamará a função de callback onComplete
onComplete undefined function Função de callback que será chamada assim que a barra tiver seu progresso maior ou igual a 100
pauseUntillComplete false boolean Boolean que define se o progresso deve ser pausado assim que chegar em 90%

Demonstração

Para ver essa lib em ação, acesse a demo

react-top-progress's People

Contributors

gustavo-kuze avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.