@rws-aoa/react-library/dist/components/atoms/icon-button/IconButton.d.ts

RWS AOA Design System

import { SxProps } from '@mui/material';
import { JSX, Ref } from 'react';
export interface AoaIconButtonProps {
    /**
     * Data-qa tag for E2E test purposes
     */
    readonly 'data-qa'?: string;
    /**
     * Whether this button should be disabled
     */
    readonly disabled?: boolean;
    /**
     * The icon to be displayed as a button
     */
    readonly icon: JSX.Element;
    /**
     * Whether this button is being used inline
     */
    readonly inline?: boolean;
    /**
     * The label that is shown on hover
     */
    readonly label: string;
    /**
     * The action that should be triggered when clicking the button
     */
    onClick(this: void, ..._args: any[]): void;
    /**
     * The ref to the button element
     */
    readonly ref?: Ref<HTMLButtonElement> | undefined;
    /**
     * Material UI's property to apply styling
     */
    readonly sx?: SxProps;
}
/**
 * Constructs an icon button using pre-defined Rijks styling
 *
 * @param props - Props to pass to the icon button
 * @example
 * ```jsx
 * <AoaIconButton onClick={() => console.log()} label='Order a burger' icon={<Fastfood />} />
 * ```
 */
export declare function AoaIconButton({ ref, ...props }: AoaIconButtonProps): import("react/jsx-runtime").JSX.Element;
//# sourceMappingURL=IconButton.d.ts.map