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

Beta Parity React Components

import React from 'react';
import './index.css';
import './variables.css';
declare const sizeMap: Record<'sm' | 'md' | 'lg', string>;
declare const colorMap: Record<'accent' | 'neutral' | 'adverse', string>;
declare const kindMap: Record<'solid' | 'outlined' | 'ghost' | 'glass', string>;
/**
 * Props for the Button component.
 *
 * Extends properties from the `button` element.
 */
export interface ButtonProps extends React.ButtonHTMLAttributes<HTMLButtonElement> {
    /**
     * The size of the button. It can be one of the keys from the sizeMap.
     *
     * @default 'md'
     * @memberof ButtonProps
     */
    size?: keyof typeof sizeMap;
    /**
     * The color of the button. It can be one of the keys from the colorMap.
     *
     * @default 'neutral'
     * @memberof ButtonProps
     */
    color?: keyof typeof colorMap;
    /**
     * The kind of button style. It can be one of the keys from the kindMap.
     *
     * @default 'solid'
     * @memberof ButtonProps
     */
    kind?: keyof typeof kindMap;
    /**
     * Indicates whether the button is in a loading state.
     *
     * @default false
     * @memberof ButtonProps
     */
    isPending?: boolean;
    /**
     * Indicates whether the button is icon-only, without any text.
     *
     * @default false
     * @memberof ButtonProps
     */
    iconOnly?: boolean;
    /**
     * Indicates whether the button is disabled.
     *
     * @default false
     * @memberof ButtonProps
     */
    disabled?: boolean;
}
/**
 * **Parity Button**.
 *
 *  @see {@link https://beta-parity-react.vercel.app/button Parity Button}
 */
export declare const Button: React.ForwardRefExoticComponent<ButtonProps & React.RefAttributes<HTMLButtonElement>>;
export {};
//# sourceMappingURL=index.d.ts.map