API reference
components/icon-button
Import
Section titled “Import”import * as api from "@fungi.computer/caps/components/icon-button";Exports
Section titled “Exports”| Kind | Export | Description |
|---|---|---|
| type alias | IconButtonIconSize | Supported IconButton glyph sizes. |
| type alias | IconButtonProps | Props accepted by IconButton. |
| constant | IconButton | A compact button for an icon control with an accessible name supplied by the caller. |
IconButtonIconSizetype alias
Section titled “IconButtonIconSize”type IconButtonIconSize = "xs" | "sm" | "md" | "lg";Supported IconButton glyph sizes.
IconButtonPropstype alias
Section titled “IconButtonProps”type IconButtonProps = object & Omit<ButtonProps, "children" | "size">;Props accepted by IconButton.
Type Declaration
Section titled “Type Declaration”| Name | Type |
|---|---|
aria-label |
string |
active? |
boolean |
icon |
ReactNode |
iconSize? |
IconButtonIconSize |
reveal? |
boolean |
size? |
ButtonProps["size"] | "responsive" |
tone? |
"default" | "destructive" |
IconButtonconstant
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.