API Reference

What components are available in noreo and how to use them.

Anatomy

Import the noreo component and customize it as needed.

MyLoader.tsx
import { Loader } from 'noreo';

export function MyLoader() {
  return (
    <div className="flex items-center justify-center min-h-screen">
      <Loader
        variant="spinner"
        size={60}
        color="#4f46e5"
        duration={1.5}
        theme="system"
      />
    </div>
  );
}

Components API

Description of props available in the noreo component.

Noreo

A flexible and minimal loader component for React.

PropTypeDefaultDescription
variant'spinner' | 'dots' | 'pulse' | 'orbit' | 'drop' | 'fade' | 'dual-ring' | 'pulse-ring' | 'bars' | 'ripple' | 'rolling' | 'wave''spinner'Choose the loader animation style.
sizenumber20Size of the loader in pixels.
colorstring"#0a0a0a"Color of the loader animation.
durationnumber1000Animation duration in seconds.
theme'light' | 'dark' | 'system''system'Automatically adapt the loader color based on the theme.
classNamestring' 'Custom classes for additional styling.
...propsReact.HTMLAttributes<HTMLDivElement>Pass any other div attributes like id, aria-*, onClick, etc.

variant

The type of animation to use.

Options:

  • spinner
  • dots
  • pulse
  • orbit
  • drop
  • fade
  • dual-ring
  • pulse-ring
  • bars
  • ripple
  • rolling
  • wave

size

Defines the width and height of the loader.

PropTypeDefault
sizenumber20px

color

Custom color for the loader. Accepts any valid CSS color value.

PropTypeDefault
colorstring"#000000"

duration

Controls the speed of the animation.

PropTypeDefault
durationnumber1000

theme

Switches the loader's color based on the user's system theme.

PropTypeDefault
theme'light' | 'dark' | 'system''system'

Summary

noreo offers a smooth, minimal, and highly customizable loading experience, supporting multiple animation styles and full theme responsiveness.