0.1.0 • Published 5 years ago

@talixo/progress-bar v0.1.0

Weekly downloads
15
License
MIT
Repository
github
Last release
5 years ago

Talixo Progress Bar

UI components for progress bars

How to install

Package is available as @talixo/progress-bar in NPM registry, so you can use it in your project using npm install @talixo/progress-bar --save or yarn add @talixo/progress-bar.

Requirements

Your package should additionally have some extra dependencies:

  • @talixo/shared: ^0.1.0
  • prop-types: ^15.6.1
  • react: ^16.2.0

These packages are required by @talixo/progress-bar, but you have to install them manually, to avoid having different versions of these in your application.

Supported props

It allows any props which are allowed for div (progress bar wrapper). Additionally, it handles some differently:

Property nameTypeDefaultDescription
classNamestringn/aadditional class name passed to wrapper
typeProgressTypen/atype of progress bar style
sizeProgressSizen/asize of progress bar
smoothbooleantrueshould it smoothly change its width?
stripedbooleanfalseshould it have stripes?
valuenumbern/aprogress to show (between 0 and 1), otherwise it's indeterminated
childrennoden/alabel to show

Remember, that progress bar without correct value will have stripes anyway in indeterminated state.

Enum types

NameValues
ProgressTypeerror, success, info, warning, secondary, tertiary
ProgressSizesmall

Changelog

  • 0.1.0 - initial version