Icon

Icon

Documentation

A supporting icon value rendered from the canonical QP icon registry or as an escaped single-grapheme symbol/emoji fallback. Unknown words and multi-grapheme strings are invalid.

Kind

Supporting Object

Required fields

name

Style Guide

Authoring guidance

Recommended

Omit ariaLabel when the containing semantic object owns the accessible meaning. Add it only when the icon itself needs contextual screen-reader text; registry descriptions are never automatic labels.

Properties

ariaLabel

string

Optional accessible label; omit for a decorative icon.

class

string

Optional styling hook.

*

name

string

Registered canonical QP icon name, or exactly one user-perceived Unicode grapheme rendered as an escaped symbol/emoji fallback. Values are strict and are not trimmed or normalized.

Example

Required

{ "name": "search" }

Full

{ "ariaLabel": "Search", "class": "example", "name": "search" }

examples are generated from the schema.