Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

react-top-loading-bar

Package Overview
Dependencies
Maintainers
1
Versions
18
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

react-top-loading-bar

A very simple, highly customisable react top loader component.

  • 1.1.0
  • Source
  • npm
  • Socket score

Version published
Weekly downloads
34K
decreased by-25.8%
Maintainers
1
Weekly downloads
 
Created
Source

react-top-loading-bar

NPM JavaScript Style Guide npm download

react-top-loading-bar

Install

  • using npm
npm install --save react-top-loading-bar
  • using yarn
yarn add react-top-loading-bar
  • CDN
https://unpkg.com/react-top-loading-bar

Usage

With ref

import React, { Component } from 'react'

import LoadingBar from 'react-top-loading-bar'

export default class ExampleWithRefs extends Component {
  render() {
    return (
      <div>
        <LoadingBar
          height={3}
          color='#f11946'
          onRef={ref => (this.LoadingBar = ref)}
        />
        <button onClick={() => this.LoadingBar.continuousStart()}>
          Start Continuous Bar Loading
        </button>
        <button onClick={() => this.LoadingBar.staticStart()}>
          Start Static Bar Loading
        </button>
        <button onClick={() => this.LoadingBar.complete()}>Complete</button>
        <br />
        <button onClick={() => this.LoadingBar.add(10)}>Add 10</button>
        <button onClick={() => this.LoadingBar.add(10)}>Add 30</button>
      </div>
    )
  }
}

With state

import React, { Component } from 'react'

import LoadingBar from 'react-top-loading-bar'

export default class App extends Component {
  state = {
    loadingBarProgress: 0
  }

  add = value => {
    this.setState({
      loadingBarProgress: this.state.loadingBarProgress + value
    })
  }

  complete = () => {
    this.setState({ loadingBarProgress: 100 })
  }

  onLoaderFinished = () => {
    this.setState({ loadingBarProgress: 0 })
  }

  render() {
    return (
      <div>
        <LoadingBar
          progress={this.state.loadingBarProgress}
          height={3}
          color='red'
          onLoaderFinished={() => this.onLoaderFinished()}
        />
        <button onClick={() => this.add(10)}>Add 10</button>
        <button onClick={() => this.add(30)}>Add 30</button>
        <button onClick={() => this.complete()}>Complete</button>
      </div>
    )
  }
}

Demo

Click here for demo

Built-in Methods

MethodsParametersDescriptions
add(value)NumberAdds a value to the loading indicator.
decrease(value)NumberDecreases a value to the loading indicator.
continousStart(startingValue) [typo - deprecated, use continuousStart]Number (optional)Starts the loading indicator with a random starting value between 20-30, then repetitively after an interval of 1s increases it by a random value between 2-10. This continues until it reaches 90% of the indicator's width.
continuousStart(startingValue)Number (optional)Starts the loading indicator with a random starting value between 20-30, then repetitively after an interval of 1s increases it by a random value between 2-10. This continues until it reaches 90% of the indicator's width.
staticStart(startingValue)Number (optional)Starts the loading indicator with a random starting value between 30-50.
complete()Makes the loading indicator reach 100% of his width and then fade.

Properties

PropertyTypeDefaultDescription
progressNumber0The progress/width indicator, progress prop varies from 0 to 100.
colorStringredThe color of the loading bar, color take values like css property background-color: do, for example red, #000 rgb(255,0,0) etc.
backgroundStringThe background css property of the bar. Can be used for gradients, images, etc.
heightNumber3The height of the loading bar in pixels.
classNameStringYou can provide a class you'd like to add to the loading bar to add some styles to it
onLoaderFinishedFunctionThis is called when the loading bar completes, reaches 100% of his width.
onProgressChangeFunctionThis is called each time loading bar value changes.
onRefFunctionThis is used to access built in methods

Projects using react-top-loading-bar

Add your own project. Make a PR

Code Style

js-standard-style

License

MIT © Klendi Gocci | klendi.me

Keywords

FAQs

Package last updated on 14 Aug 2019

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc