Stylized icon within a rounded box with customizable colors, sizes, and variants.
Choose from different color schemes to match different contexts and use cases.
Choose from five different sizes to fit various design needs. The default size is md
.
Use the inverted
variant when representing a related model or if the designs indicate it should be subtle.
Use the selected state to indicate to the user it is active. Often used in Filter Popovers.
IconBox works with any icon from the Hightouch UI icon library.
Wrap a Tooltip
to provide more information to the user.
IconBox
uses our theme button shadow, which means you cannot render it within a tightly bounded container with overflow="hidden"
. Ensure the box shadow is always visible when using IconBox
.
Name | Default | Description |
---|---|---|
isSelected | false | boolean Selected icon boxes have a different background color. |
color | — | "gray" | "indigo" | "green" | "blue" | "pink" | "orange" | "teal" | "yellow" | "red" The color shade of the IconBox determines the background, border, and icon color. |
icon | — | JSX.Element The icon to display. |
size | "md" | "xs" | "sm" | "md" | "lg" | "xl" The size of the IconBox. |
variant | "default" | "default" | "inverted" The variant determines the visual style of the IconBox. Inverted variants have a white background with colored borders and icons. |