retro-react
Version:
A React component library for building retro-style websites
47 lines (46 loc) • 1.5 kB
TypeScript
/// <reference types="react" />
import { ThemeUICSSObject } from 'theme-ui';
export declare type ButtonVariant = 'primary' | 'secondary' | 'success' | 'warning' | 'outline' | 'flat';
export declare type ButtonSize = 'small' | 'medium' | 'large';
export interface ButtonProps extends React.ButtonHTMLAttributes<HTMLButtonElement> {
/**
* The visual style of the Button.
* - primary: Classic blue primary button
* - secondary: Classic grey secondary button
* - success: Classic green success button
* - warning: Classic yellow warning button
* - outline: Outlined button style
* - flat: Flat button style
*
* @default 'primary'
*/
variant?: ButtonVariant;
/**
* The size of the Button.
*
* @default 'medium'
*/
size?: ButtonSize;
/**
* If true disables the click transform effect.
*
* @default false
*/
disableClickEffect?: boolean;
sx?: ThemeUICSSObject;
/**
* @internal
*
* Modify styles for ButtonGroup component.
*/
isButtonGroup?: boolean;
}
/**
* Buttons are used to trigger an action or event, such as submitting a form, opening a dialog, canceling an action, or performing a delete operation.
*
* @example
* <Button variant="success">
* Submit
* </Button>
*/
export declare const Button: import("react").ForwardRefExoticComponent<ButtonProps & import("react").RefAttributes<HTMLButtonElement>>;