Custom menus support Font Awesome icons. When creating or updating a custom menu, pass an icon object with two fields:
Icon object
| Field | Type | Required | Description |
|---|
name | string | Yes | The Font Awesome icon name (without prefix). Example: "yin-yang" |
fontFamily | string | Yes | The Font Awesome style prefix. One of fab, fas, or far. |
Example
{
"icon": {
"name": "yin-yang",
"fontFamily": "fas"
}
}
Font family options
| Value | Style | Description |
|---|
fas | Solid | Filled solid icons (most common) |
far | Regular | Outlined/regular weight icons |
fab | Brands | Brand logos (e.g., GitHub, Twitter) |
Finding icon names
Browse the full icon library at fontawesome.com/icons. Use the icon name exactly as shown (e.g., home, envelope, chart-bar) — without any fa- prefix.
The fas (solid) family has the widest selection and works for most use cases.
