RegisterIconOptions

Options for registering an SVG icon.

Properties

Section titled "Properties"

Optional collection

Section titled "collection"

The collection to register the icon in.

 
collection?: string

Defined in src/components/icon/registry/types.ts:67

Optional stripMeta

Section titled "stripMeta"

Whether to strip SVG meta elements (<title> and <desc>) from the icon before storing it.

 
stripMeta?: boolean

Defined in src/components/icon/registry/types.ts:91

Remarks

SVG <title> elements cause the browser to display a native tooltip when the user hovers over the icon - an undesirable side-effect when using icon packs such as @igniteui/material-icons-extended that embed accessible metadata inside every icon.

When stripMeta is true:

  • The <title> and <desc> child elements are removed from the stored SVG.
  • Any aria-labelledby / aria-describedby references on the root <svg> element that pointed to the stripped elements' IDs are cleaned up so the resulting markup contains no dangling ARIA references.
  • The title text is still captured and stored as SvgIcon.title, which the icon component continues to expose as its host aria-label. Accessibility is therefore preserved at the component level while the browser tooltip is suppressed at the SVG level.