@hdoc-react/spinner

@hdoc-react/spinner

Simple spinner component for your React app

Installation

npm install @hdoc-react/spinner

Usage

import { RingSpinner } from "@hdoc-react/spinner";

function App() {
  return (
    <>
      <RingSpinner />
    </>
  );
}

Props

size

The size of the spinner.

Type: 'small' | 'large'

speed

The speed of the spinner.

Type: 'slow' | 'fast'

color

The color of the spinner.

Type: 'primary' | 'secondary' | 'error' | 'warning' | 'info' | 'success'

className

Additional class names for extending styles.

Type: string

Customization

CSS Custom Properties

You can customize the spinner by using the following CSS custom properties:

.any-parent-of-spinner,
.class-to-extend-styles {
  --spinner-size: 24px;
  --spinner-color: black; /* default color */
  --spinner-animation-duration: 1s;

  /* COLOR VARIANTS */
  --primary: lightblue;
  --secondary: lightgray;
  --error: red;
  --warning: orange;
  --info: skyblue;
  --success: green;
}

CSS classes

.ring-spinner

The base styles for the spinner

.spinner--small

The small styles for the spinner

.spinner--large

The large styles for the spinner

.spinner--slow

The slow styles for the spinner

.spinner--fast

The fast styles for the spinner

.spinner--primary

The primary styles for the spinner

.spinner--secondary

The secondary styles for the spinner

.spinner--error

The error styles for the spinner

.spinner--warning

The warning styles for the spinner

.spinner--info

The info styles for the spinner

.spinner--success

The success styles for the spinner