Icon ✦Documentation has not yet been reviewed by a human.

Use Icon for standalone symbols, such as a warning beside a message. Pass a shape from Anta’s built-in set or your generated icons. Color follows the surrounding text, and the default size is 16×16 pixels.

shape="loader" is the exception: it is Anta’s animated loading alias for string-only icon props. Use Loader when you need a progress value, speed, or accessible loading status.

In practice you’ll rarely reach for <Icon> directly. Most Anta components that need an icon expose an icon prop that’s typed against IconShape — autocomplete and type-checking work the same way without the wrapping element. Use <Icon> when you need a standalone icon outside of any other component.

Built-in shapes

<a-icon
  shape="warning-triangle"
  role="img"
  aria-label="Warning"
  style="--icon-size: 24px"
></a-icon>

Sizing and color

Pass size (a number, in pixels) to control width and height together. Default is 16. Color always follows currentColor.

<Icon shape="chevron-down" />                                  {/* 16×16, current color */}
<Icon shape="check" size={24} />                               {/* 24×24 */}
<Text tone="critical"><Icon shape="warning-triangle" /></Text> {/* tinted */}

Set --icon-size on a container to size its icons together:

.toolbar { --icon-size: 18px; }

For a raw <a-icon>, use --icon-size for custom dimensions. Its size attribute requires typed CSS attr() support. See Content Security Policy when your policy blocks inline styles from custom size props.

The blank spacer

shape="blank" renders nothing but still occupies a full icon box at the current size. Use it to reserve a leading-icon column so labels line up when only some rows carry an icon — a menu or list where a few items have a leading glyph and the rest shouldn’t shift.

<Icon shape="blank" />                    {/* invisible 16×16 spacer */}
<MenuItem icon="blank" label="No icon, but aligned" />

Note this differs from omitting the icon: leaving shape (or MenuItem’s icon) unset renders no element, while blank renders an invisible sized box. A bare <Icon> with no shape is not a spacer — with no mask it paints a solid square.

Adding your own icons

Anta ships a generator script at dist/generate-icons.mjs. Drop your SVGs in a folder, point the script at it, and it emits a CSS file plus a TypeScript declaration that augments Anta’s IconShapes interface — your shapes become valid <Icon shape="…" /> values automatically, with autocomplete.

node ./node_modules/@antadesign/anta/dist/generate-icons.mjs \
  --input ./svgs \
  --output ./src/icons \
  --name my-icons

--input and --output are arbitrary paths in your project — pick whatever fits your layout. The example above writes ./src/icons/my-icons.css and ./src/icons/my-icons.d.ts. Import the CSS once at runtime; the .d.ts only needs to be in your TypeScript include path (the same tsconfig.json include that already covers your other source files), nothing else.

import './icons/my-icons.css'   // runtime: registers shape rules on <a-icon>

You can now use <Icon shape="my-shape" /> with full type safety.

SVG conventions

The generator strips width= and height= from the root <svg> so size is fully under the host element’s CSS. For best results:

• Use viewBox="0 0 16 16" (or any square viewBox).
• Use stroke="currentColor" (or fill="currentColor") — the icon is recolored via CSS background-color: currentColor masked through the SVG’s alpha. Black/colored fills work too, but only the alpha matters; the shape is always rendered in the current text color.
• Single-color icons only. Multi-color SVGs collapse to one color because the entire shape is masked through currentColor.

Conflicting shape names

If a generated shape has the same name as one of Anta’s built-ins (e.g. chevron-down), the generator prints a warning. At runtime, the CSS file imported last wins — so importing your generated CSS after @antadesign/anta/elements overrides the matching built-ins. TypeScript silently merges the duplicate keys; both names remain valid at the type level.

Programmatic use

import { generate } from '@antadesign/anta/generate-icons.mjs'

await generate({
  input:  './svgs',
  output: './src/icons',
  name:   'my-icons',
})

Useful for wiring icon generation into a build script.