SUIComponents

AtomIcon

Props

as

requiredno
typeelementType
defaultValue'span'

children

requiredno
typeelement

The children must be a SVG that follows the definition stated on the UXDEF.md.

className

requiredno
typestring

CSS Classes to add to icon

color

requiredno
typeenum
defaultValueATOM_ICON_COLORS.currentColor

Determine color of the icon Besides the primary color types, you could use currentColor to inherit the color from the parent. (default: ATOM_ICON_COLORS.currentColor)

render

requiredno
typeenum
defaultValueATOM_ICON_RENDERS.eager

Determine the render type of the icon. 'eager': The icon will be server-side rendered (default) 'lazy': The icon will be loaded on a client when visible

size

requiredno
typeenum
defaultValueATOM_ICON_SIZES.small

Determine the size of the icon. (default: ATOM_ICON_SIZES.medium)