Loaders

Lightweight loaders & spinners for your next React project.

24 Types 🎨 — Unique enough to be interesting; simple enough to use in real-world projects
Customizable 🖌️ — Set the size, color, line weight and animation speed to match your design
Tiny 🦐 — Individual loaders are < 1kb gzipped
No gifs 📷 — Built with HTML and modern CSS. A couple loaders use lightweight SVG as well
Zero dependencies ⛓️ — Zero worries.

Visit the 🌐 Website to see them all in action.

Installation

NPM

npm install @uiball/loaders

Yarn

yarn add @uiball/loaders

Getting Started

Import individual loader components. Use them wherever you like. The full list can be found on the website.

import { Waveform } from '@uiball/loaders'

export default function PageSection({ isLoading }) {
  return (
    <div aria-live="polite" aria-busy={isLoading}>
      {isLoading && <Waveform />}
    </div>
  )
}

Tree Shaking

This package is designed to maximize the benefits of tree shaking; so when you use a modern bundler like Webpack, Rollup or Parcel, and import { Orbit } from '@uiball/loaders' only the tiny code for the Orbit loader ends up in your app.

Options

Each loader has different defaults. You can see them on the website. Click on an individual loader and open the "source" sidebar. Default values will be listed at the top, followed by HTML and CSS if you want to copy/paste rather than use the React components.

`size: number`

The size of the loader. Specifically, this defines the largest dimension (height or width) in pixels.

<Ring size={35} />

`color: string`

Any valid CSS color value is accepted, so #000000, red, hsl(13, 68%, 63%) and var(--my-custom-color) are all a-okay.

<Ring color="papayawhip" />

`speed: number`

The speed of the animation. Each loader uses this number a little differently (individual parts of a given loader might have different timing), but in general this number represents the duration of a single full animation loop in seconds, so smaller = faster.

<Ring speed="1.75" />

`lineWeight: number`

The width / stroke in pixels of line-based loaders like <Waveform /> or <RaceBy />. You can see if an individual loader supports this property on the website.

<MrMiyagi lineWeight="3.5" />

Platform Support

This package only supports modern ESM import syntax, so no require()-ing.

Next.js doesn't transpile imported modules by default, but you can add support with this package: https://www.npmjs.com/package/next-transpile-modules. More details can be found here: https://stackoverflow.com/a/65939797

Lots of helpful detail from @sindresorhus: https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c

Loaders make use of CSS custom properties (CSS variables) and keyframe animations, which work great in all modern browsers. Internet Explorer is not supported, however.

License

MIT

ugursepetci/uiball-loaders