LogoLogo
  • What is UDML?
  • Document structure
    • <components>
    • <imports>
    • <instructions>
    • <meta>
    • <styles>
    • <tokens>
    • <mappings>
    • <screens>
  • Directives
    • ai-hint
    • <data> Directive Specification
    • <interaction> Directive
    • <layer> Directive
    • <repeat> Directive
    • <responsive>
    • selection
    • <tracking> Directive
  • Components
    • Layout
      • <accordion> Component
      • <box> Component
      • <column> Component
      • <divider>
      • <grid> Component
      • <row> Component
    • Navigation
      • <breadcrumbs> Component
      • <pagination> Component
      • <tab> Component
      • <tabs> Component
    • Text & Display
      • <avatar>
      • <heading>
      • <icon>
      • <image>
      • <label>
      • <text>
      • <video>
    • Controls & Input
      • <button>
      • <checkbox>
      • <input> Component
      • <radio>
      • <select>
      • <slider>
      • <stepper>
      • <switch>
      • <textarea>
    • Forms
      • <form> Component
      • <formField> Component
      • <formGroup> Component
    • Data Collections
      • <dataColumn> Component
      • <dataTable> Component
      • <list> Component
      • <timeline> Component
      • <treeView> Component
    • Data Visualization
      • <chart> Component
      • <summary> Component
    • Modals
      • <dialog> Component
      • <modal> Component
      • <popover> Component
      • <toast> Component
      • <tooltip> Component
  • Prompting Guides
    • Prompting AI Developer Tools with UDML
    • Working with UDML in an Existing Codebase
  • Contributing to UDML
Powered by GitBook
On this page
  • The <icon> component renders a named vector icon. It supports alignment, size, and color styling.
  • 🛠 Attributes
  • ✅ Allowed Content
  • 💡 Examples
  • 🧩 AI Interpretation Guidelines
Edit on GitHub
  1. Components
  2. Text & Display

<icon>

The <icon> component renders a named vector icon. It supports alignment, size, and color styling.

🛠 Attributes

Attribute
Type
Required
Description

name

string

Yes

Icon identifier (e.g., search, check, trash)

size

string

No

Pixel or token value (e.g., 24px, sm)

color

string

No

Icon color or token

ariaLabel

string

No

Accessible label for screen readers

✅ Allowed Content

Self-closing only. No children.

💡 Examples

Simple icon

<icon name="check" color="success"/>

🧩 AI Interpretation Guidelines

  • Map name to an icon set (e.g., Lucide, Material, Feather).

  • Use ariaLabel for accessible usage if the icon is not decorative.

  • Position inline with text or next to interactive elements.

Previous<heading>Next<image>

Last updated 1 month ago