react-loader-spinner
Version:
react-spinner-loader provides simple React.js spinner component which can be implemented for async wait operation before data load to the view.
42 lines (39 loc) • 1.55 kB
TypeScript
import { FunctionComponent, CSSProperties } from 'react';
/**
* Props for the ProgressBar loader component.
*
* The ProgressBar loader displays a horizontal progress bar animation.
*
* @interface ProgressBarProps
*/
interface ProgressBarProps {
/** Height of the SVG (number interpreted as px). */
height?: string | number;
/** Width of the SVG (number interpreted as px). */
width?: string | number;
/** Primary color applied to the loader. */
color?: string;
/** Color of the progress bar border. Defaults to '#F4442E'. */
borderColor?: string;
/** Color of the progress bar fill. Defaults to '#51E5FF'. */
barColor?: string;
/** Accessible label announced to screen readers. */
ariaLabel?: string;
/** Inline style object applied to the wrapper element. */
wrapperStyle?: CSSProperties;
/** CSS class applied to the wrapper for custom styling. */
wrapperClass?: string;
/** When false, the loader is not rendered. Defaults to true. */
visible?: boolean;
/**
* Provide multiple colors to render a gradient instead of a solid color.
* When 2 or more colors are supplied a gradient will be applied to the loader.
*/
colors?: string[];
/** Type of gradient (linear or radial). Defaults to linear. */
gradientType?: 'linear' | 'radial';
/** Angle (in degrees) applied via rotate() transform for linear gradients. */
gradientAngle?: number;
}
declare const ProgressBar: FunctionComponent<ProgressBarProps>;
export { ProgressBar };