@atlaskit/spinner

Spinner

Spinners are used for showing a system process of unknown length going on that ends with the system displaying results to the user.

Try it out

Interact with a live demo of the @atlaskit/spinner component.

Installation

npm install @atlaskit/spinner

Using the component

Import the component in your React app as follows:

import Spinner from '@atlaskit/spinner';
ReactDOM.render(<Spinner />, container);

The spinner will display a loading in animation and then continue spinning until the isCompleting prop is set on it.

If this prop is set to true the spinner will begin playing the outro animation (approximately 300ms).

You can be notified once the animation is complete by hooking into the onComplete callback like so.

import Spinner from '@atlaskit/spinner';

// some flag that we will set once our long running task is complete
let loadingFinishedFlag = false;

function loadingFinished() {
  // show our loaded content, etc
}

// this would normally be in a component or an app
ReactDOM.render(<Spinner
  isCompleting={loadingFinishedFlag}
  onComplete={loadingFinished}
/>);

The result is a very smooth loading in and out animation that should feel seamless to the user.

* Please note that this module could have dependencies that are governed by the Atlassian Design Guidelines license which will be automatically included on install. Each dependency has a license file that indicates whether the Atlassian Design Guidelines license applies.

We're here to help!

Let us know what you think of our components and docs, your feedback is really important for us.

Are you in trouble? Read through our contribution guidelines and raise an issue to us.