@metamask/design-system-react
Version:
Design system react ui components
51 lines • 1.49 kB
text/typescript
import type { ComponentProps } from "react";
import type { ButtonIconSize } from "../../types/index.cjs";
import type { IconName, IconProps } from "../Icon/index.cjs";
export type ButtonIconProps = ComponentProps<'button'> & {
/**
* Required prop to specify the icon to show
*/
iconName: IconName;
/**
* Required prop to provide an accessible label for the button
*/
ariaLabel: string;
/**
* Optional prop to pass additional properties to the icon
*/
iconProps?: Partial<IconProps>;
/**
* Optional prop that when true, disables the button
*
* @default false
*/
isDisabled?: boolean;
/**
* Optional prop that when true, applies inverse styling to the button
*
* @default false
*/
isInverse?: boolean;
/**
* Optional prop that when true, applies floating/contained styling to the button
*
* @default false
*/
isFloating?: boolean;
/**
* Optional prop to control the size of the button
*
* @default ButtonIconSize.Md
*/
size?: ButtonIconSize;
/**
* Optional prop for additional CSS classes to be applied to the ButtonIcon component
*/
className?: string;
/**
* Optional CSS styles to be applied to the component.
* Should be used sparingly and only for dynamic styles that can't be achieved with className.
*/
style?: React.CSSProperties;
};
//# sourceMappingURL=ButtonIcon.types.d.cts.map