beta-parity-react
Version:
Beta Parity React Components
40 lines • 1.04 kB
TypeScript
import React from 'react';
import './index.css';
import './variables.css';
declare const sizeMap: Record<'xs' | 'sm' | 'md' | 'lg' | 'xl', string>;
/**
* Props for the Dot component.
*
* Extends properties from the `span` element.
*/
export interface DotProps extends React.HTMLAttributes<HTMLSpanElement> {
/**
* The size of the dot.
*
* @default 'md'
* @memberof DotProps
*/
size?: keyof typeof sizeMap;
/**
* Whether the dot has a pulsing animation.
*
* @default false
* @memberof DotProps
*/
pulse?: boolean;
/**
* The color of the dot.
*
* @default 'gray'
* @memberof DotProps
*/
color?: 'gray' | 'orange' | 'violet' | 'green' | 'red' | 'yellow' | 'blue' | 'lime' | 'cyan';
}
/**
* **Parity Dot**.
*
* @see {@link https://beta-parity-react.vercel.app/dot Parity Dot}
*/
export declare const Dot: React.ForwardRefExoticComponent<DotProps & React.RefAttributes<HTMLSpanElement>>;
export {};
//# sourceMappingURL=index.d.ts.map