🚧 This documentation is a work in progress. Coming from @studs/react? See our Migration Guide.

Icon

A flexible wrapper for rendering icon components with consistent sizing and styling.

The Icon component provides a standardized way to render icons from various icon libraries or custom SVG components. It handles sizing, coloring, and ensures consistent appearance across your application.

Example

"use client"

import { Icon } from "@strongtie/design-system/icon"
import { MdHome, MdPerson, MdSearch, MdSettings } from "react-icons/md"

export function IconDefault() {
  return (
    <div className="flex items-center gap-4">
      <Icon as={MdHome} boxSize="24px" />
      <Icon as={MdSettings} boxSize="24px" />
      <Icon as={MdSearch} boxSize="24px" />
      <Icon as={MdPerson} boxSize="24px" />
    </div>
  )
}

Installation


npm install @strongtie/design-system

import { Icon } from "@strongtie/design-system/icon"

Props

`<Icon>`

Prop	Type	Default	Description
`as`	`ElementType<any, keyof IntrinsicElements>`	`svg`	The component or element type to render as the icon.
`boxSize`	`string \| number`	`1em`	The size of the icon (width and height).
`color`	`string`	`currentColor`	The color of the icon fill.

Examples

"use client"

import { Icon } from "@strongtie/design-system/icon"
import { MdHome, MdPerson, MdSearch, MdSettings } from "react-icons/md"

export function IconDefault() {
  return (
    <div className="flex items-center gap-4">
      <Icon as={MdHome} boxSize="24px" />
      <Icon as={MdSettings} boxSize="24px" />
      <Icon as={MdSearch} boxSize="24px" />
      <Icon as={MdPerson} boxSize="24px" />
    </div>
  )
}

Custom Svg

"use client"

import { Icon } from "@strongtie/design-system/icon"

export function IconCustomSvg() {
  return (
    <Icon as="svg" boxSize="2em" viewBox="0 -960 960 960" fill="currentColor">
      <path d="M784-120 532-372q-30 24-69 38t-83 14q-109 0-184.5-75.5T120-580q0-109 75.5-184.5T380-840q109 0 184.5 75.5T640-580q0 44-14 83t-38 69l252 252-56 56ZM380-400q75 0 127.5-52.5T560-580q0-75-52.5-127.5T380-760q-75 0-127.5 52.5T200-580q0 75 52.5 127.5T380-400Z" />
    </Icon>
  )
}

Different Color

"use client"

import { Icon } from "@strongtie/design-system/icon"
import { MdSearch } from "react-icons/md"

export function IconDifferentColor() {
  return (
    <div className="flex items-center gap-4">
      <Icon as={MdSearch} boxSize="2em" color="red" />
      <Icon as={MdSearch} boxSize="2em" color="blue" />
      <Icon as={MdSearch} boxSize="2em" color="green" />
      <Icon as={MdSearch} boxSize="2em" color="purple" />
    </div>
  )
}

Different Size

"use client"

import { Icon } from "@strongtie/design-system/icon"
import { MdSearch } from "react-icons/md"

export function IconDifferentSize() {
  return (
    <div className="flex items-center gap-4">
      <Icon as={MdSearch} boxSize="1em" />
      <Icon as={MdSearch} boxSize="1.5em" />
      <Icon as={MdSearch} boxSize="2em" />
      <Icon as={MdSearch} boxSize="3em" />
    </div>
  )
}

Styling

Components can be styled using the className prop. The design system uses Tailwind CSS for styling.

Component Slots

The following data attributes are used to identify component parts:

icon

Accessibility

Ensure proper accessibility attributes are added when implementing this component.

Hover Card Input

On This Page

Example Installation Props <Icon>Examples Custom Svg Different Color Different Size Styling Component Slots Accessibility

Contribute