Components

Icons

Render Material Symbols, decorative shapes, tool glyphs, and brand logos.

Colorffy UI provides four icon components. All share base props — size, color, decorative, and ariaLabel (required when decorative is false).

Material Symbols

Pass a Material Symbols entity code:

<template>
  <UiIconMaterial icon-code="&#xe88a;" />
  <UiIconMaterial icon-code="&#xe838;" :size="32" color="var(--theme-primary-base)" />
</template>

Decorative shapes

<template>
  <UiIconShapes shape="blob-3" />
  <UiIconShapes shape="star-5" :size="48" />
</template>

Tool & brand glyphs

<template>
  <UiIconTool tool="Google Analytics" />
  <UiIconApp brand="github" />
</template>

Shared base props

PropTypeDefaultDescription
size'xs' | 'sm' | 'md' | 'lg' | 'xl' | numberSize token or px/em value.
colorstring | nullcurrentColorOverride color.
decorativebooleantrueHide from assistive tech.
ariaLabelstring | nullRequired when decorative is false.

Per-component prop

ComponentRequired propValues
UiIconMaterialiconCodeMaterial Symbols entity (e.g. &#xe88a;)
UiIconShapesshapeblob-1blob-7, star-1star-8, circle-1circle-4, shape-1shape-4, lighting-1
UiIconTooltoolStripe, Google Analytics, Firebase Console, Search Console, …
UiIconAppbrand (or icon)github, google, apple, nuxt, discord, twitter, …
Copyright © 2026