@teste-ui/spinner
Version:
A React component for displaying spinners and loaders
47 lines • 1.3 kB
TypeScript
import { ThemingProps, HTMLChakraProps } from "@teste-ui/system";
interface SpinnerOptions {
/**
* The color of the empty area in the spinner
* @default "transparent"
*/
emptyColor?: string;
/**
* The color of the spinner
*/
color?: string;
/**
* The thickness of the spinner
* @default "2px"
* @example
* ```jsx
* <Spinner thickness="4px"/>
* ```
*/
thickness?: string;
/**
* The speed of the spinner.
* @default "0.45s"
* @example
* ```jsx
* <Spinner speed="0.2s"/>
* ```
*/
speed?: string;
/**
* For accessibility, it is important to add a fallback loading text.
* This text will be visible to screen readers.
* @default "Loading..."
*/
label?: string;
}
export interface SpinnerProps extends Omit<HTMLChakraProps<"div">, keyof SpinnerOptions>, SpinnerOptions, ThemingProps<"Spinner"> {
}
/**
* Spinner is used to indicate the loading state of a page or a component,
* It renders a `div` by default.
*
* @see Docs https://teste-ui.com/spinner
*/
export declare const Spinner: import("@teste-ui/system").ComponentWithAs<"div", SpinnerProps>;
export {};
//# sourceMappingURL=spinner.d.ts.map