beta-parity-react/ui/Spinner/index.d.ts

Beta Parity React Components

import React from 'react';
import './variables.css';
import './index.css';
/**
 * Props for the Spinner component.
 *
 * Extends properties from the `span` element.
 */
export interface SpinnerProps extends React.HTMLAttributes<HTMLSpanElement> {
    /**
     * The variant/style of the spinner.
     *
     * - `circular`: A circular spinner that rotates.
     * - `dotted`: A spinner with dots indicating progress.
     * - `sunburst`: A spinner resembling a sunburst pattern.
     *
     * @default 'circular'
     * @memberof SpinnerProps
     */
    variant?: 'circular' | 'dotted' | 'sunburst';
    /**
     * The color theme of the spinner.
     *
     * - `neutral`: A neutral color, typically gray or subdued.
     * - `accent`: An accent color, often used for highlighting.
     *
     * @default 'neutral'
     * @memberof SpinnerProps
     */
    color?: 'neutral' | 'accent';
    /**
     * The size of the spinner.
     *
     * - `sm`: Small size, suitable for compact areas.
     * - `md`: Medium size, the default spinner size.
     * - `lg`: Large size, suitable for prominent loading indicators.
     * - `xl`: Extra-large size, suitable for larger loading indicators.
     *
     * @default 'md'
     * @memberof SpinnerProps
     */
    size?: 'sm' | 'md' | 'lg' | 'xl';
}
/**
 * **Parity Spinner**.
 *
 *  @see {@link https://beta-parity-react.vercel.app/spinner Parity Spinner}
 */
declare const Spinner: React.ForwardRefExoticComponent<SpinnerProps & React.RefAttributes<HTMLSpanElement>>;
export { Spinner };
//# sourceMappingURL=index.d.ts.map