AnyLumino
API referenceastryxdata

Icon

Render an Astryx icon by name.

Astryx Props

JSON-safe Icon props forwarded to Astryx.

Supported Astryx props include:

  • icon (IconName or ComponentType<SVGProps>; required): Semantic icon name or SVG component. Valid semantic names: close, chevronDown, chevronLeft, chevronRight, check, success, error, warning, info, calendar, clock, externalLink, menu, moreHorizontal, search, arrowUp, arrowDown, arrowsUpDown, funnel, eyeSlash, viewColumns, copy, checkDouble, wrench, stop, microphone. For any icon not in this list, pass an SVG component directly (e.g. import from lucide-react or @heroicons/react). Note: this prop is called 'icon', not 'name'.
  • color ('primary' or 'secondary' or 'tertiary' or 'disabled' or 'accent' or 'success' or 'error' or 'warning' or 'inherit'): Color variant mapped to Astryx icon color tokens.
  • size ('xsm' or 'sm' or 'md' or 'lg'): Icon size.

See Astryx component docs: https://astryx.atmeta.com/components/Icon.

Functions

constructor__init__(icon, *, color=None, size=None, **props) -> None
paramiconstr

Astryx icon name.

paramcolorstr | None
= None

Theme icon color.

paramsizestr | None
= None

Icon size.

parampropsAny
= {}

Returns

None

On this page