Type alias IconButtonProps

IconButtonProps: PropsWithChildren<{
    adjustMarginToAlignToEdge?: "end" | "start" | false;
    className?: string;
    id?: string;
    isDisabled?: boolean;
    isTooltipSuppressed?: boolean;
    label: string;
    onClick?: MouseEventHandler<HTMLButtonElement>;
    size: "small" | "medium" | "large";
    tooltip?: string;
}>

Type declaration

  • Optional adjustMarginToAlignToEdge?: "end" | "start" | false

    If given, uses a negative margin to counteract the padding on one side (this is often helpful for aligning the left or right side of the icon with content above or below, without ruining the border size and shape).

    Default

    false
  • Optional className?: string

    Additional css classes to help with unique styling of the button

  • Optional id?: string

    Optional unique identifier

  • Optional isDisabled?: boolean

    Enabled status of button

    Default

    false
  • Optional isTooltipSuppressed?: boolean

    If true, no tooltip will be displayed.

  • label: string

    Required. Used as both the tooltip (aka, title) and the aria-label (used for accessibility, testing, etc.), unless a distinct tooltip is supplied.

  • Optional onClick?: MouseEventHandler<HTMLButtonElement>

    Optional click handler

  • size: "small" | "medium" | "large"

    The size of the component. small is equivalent to the dense button styling.

    Default

    false
  • Optional tooltip?: string

    Optional tooltip to display if different from the aria-label.

Settings

Member Visibility

Theme