Skip to content
Fungi

components/icon-button

@fungi.computer/caps

@fungi.computer/caps / components/icon-button

components/icon-button

Section titled “components/icon-button”

Type Aliases

Section titled “Type Aliases”

IconButtonIconSize

Section titled “IconButtonIconSize”

IconButtonIconSize = "xs" | "sm" | "md" | "lg"

Supported IconButton glyph sizes.

IconButtonProps

Section titled “IconButtonProps”

IconButtonProps = object & Omit<ButtonProps, "children" | "size">>

Props accepted by IconButton.

Type Declaration

Section titled “Type Declaration”
aria-label
Section titled “aria-label”

aria-label: string

active?
Section titled “active?”

optional active?: boolean

icon
Section titled “icon”

icon: ReactNode

iconSize?
Section titled “iconSize?”

optional iconSize?: IconButtonIconSize

reveal?
Section titled “reveal?”

optional reveal?: boolean

size?
Section titled “size?”

optional size?: ButtonProps["size"] | "responsive"

tone?
Section titled “tone?”

optional tone?: "default" | "destructive"

Variables

Section titled “Variables”

IconButton

Section titled “IconButton”

const IconButton: ForwardRefExoticComponent<object & Omit<ButtonProps, "children" | "size"> > & RefAttributes<HTMLButtonElement>>>>

A compact button for an icon control with an accessible name supplied by the caller.