carbon-react
Version:
A library of reusable React components for easily building user interfaces.
33 lines (32 loc) • 1.48 kB
TypeScript
import React from "react";
import { SpaceProps } from "styled-system";
import { TagProps } from "../../__internal__/utils/helpers/tags";
import { IconProps } from "../icon";
/**
* @deprecated `IconButton` has been deprecated. See the Carbon documentation for migration details.
*/
export interface IconButtonProps extends SpaceProps, TagProps {
/** Prop to specify the aria-label of the icon-button component */
"aria-label"?: string;
/** Icon meant to be rendered, should be an Icon component */
children: React.ReactElement<IconProps>;
/** Callback triggered on blur */
onBlur?: (ev: React.FocusEvent<HTMLButtonElement>) => void;
/** Callback triggered on focus */
onFocus?: (ev: React.FocusEvent<HTMLButtonElement>) => void;
/** Callback triggered on mouse enter */
onMouseEnter?: (ev: React.MouseEvent<HTMLButtonElement>) => void;
/** Callback triggered on mouse leave */
onMouseLeave?: (ev: React.MouseEvent<HTMLButtonElement>) => void;
/** Set the button to disabled */
disabled?: boolean;
/** Callback triggered on click */
onClick?: (e: React.MouseEvent<HTMLButtonElement>) => void;
/** @private @internal @ignore */
"data-component"?: string;
}
/**
* @deprecated `IconButton` has been deprecated. See the Carbon documentation for migration details.
*/
declare const IconButton: React.ForwardRefExoticComponent<IconButtonProps & React.RefAttributes<HTMLButtonElement>>;
export default IconButton;