Components · Content
Icon
An icon by name, in the text color. size: xs to xl. tone: default, muted, a status tone, or accent (the theme's accent, or blue on the default palette). Decorative unless label is set. Names: file-text, notes, notebook, book, book-2, writing, pencil, feather, quote, report, presentation, clipboard, archive, folder, paperclip, link, checklist, list-check, clipboard-list, clipboard-check, list-details, map, route, target, flag, compass, timeline, sitemap, hierarchy, gavel, scale, rocket, bulb, brain, search, microscope, flask, school, atom, language, code, terminal-2, brackets, git-branch, git-pull-request, git-merge, api, bug, puzzle, plug, tool, settings, adjustments, components, layout-dashboard, robot, package, database, server, cloud, cpu, table, chart-bar, chart-line, chart-pie, chart-dots, trending-up, stack-2, versions, calendar, calendar-event, clock, hourglass, alarm, refresh, lock, key, shield, shield-check, fingerprint, eye, users, user, message-circle, mail, bell, speakerphone, lifebuoy, circle-check, alert-triangle, info-circle, help-circle, ban, bolt, flame, sparkles, star, heart, trophy, home, building, briefcase, currency-dollar, shopping-cart, world, palette, photo, device-laptop, device-mobile, coffee, leaf, arrow-right, arrow-left, arrow-up-right, chevron-right, chevron-left, chevron-down, chevron-up, check, x, plus, minus, menu-2, dots, external-link, download, upload, send, player-play, trash, copy, filter, share, bookmark, tag, at, phone, map-pin, credit-card, gift, truck, thumb-up, login, logout, sun, moon. Brand marks, outline only and in the text color, for social links and sign-in buttons (an icon-only Button or Link with one needs a label naming the network, such as "GitHub"): brand-github, brand-gitlab, brand-x, brand-linkedin, brand-youtube, brand-instagram, brand-facebook, brand-tiktok, brand-discord, brand-mastodon, brand-bluesky, brand-threads, brand-reddit, brand-twitch, brand-dribbble, brand-behance, brand-medium, brand-apple, brand-google, brand-windows, brand-android.
ExamplesLink to this section
All checks passed.
Show JSONHide JSON
{
"version": 1,
"root": "row",
"elements": {
"row": {
"type": "Box",
"props": { "direction": "horizontal", "align": "center", "gap": "sm" },
"children": ["mark", "words"]
},
"mark": {
"type": "Icon",
"props": { "name": "circle-check", "tone": "success" }
},
"words": { "type": "Text", "props": { "text": "All checks passed." } }
}
}With a `label` the icon is announced; without one it is decorative.
Show JSONHide JSON
{
"version": 1,
"root": "icon",
"elements": {
"icon": {
"type": "Icon",
"props": {
"name": "star",
"size": "lg",
"tone": "warning",
"label": "Rated five stars"
}
}
}
}New in this release.
Show JSONHide JSON
{
"version": 1,
"root": "row",
"elements": {
"row": {
"type": "Box",
"props": { "direction": "horizontal", "align": "center", "gap": "sm" },
"children": ["mark", "words"]
},
"mark": {
"type": "Icon",
"props": { "name": "sparkles", "tone": "accent" }
},
"words": {
"type": "Text",
"props": { "text": "New in this release.", "tone": "accent" }
}
}
}Each mark is an icon-only Button, so its `label` names the network for screen readers.
© 2026 Northwind
Show JSONHide JSON
{
"version": 1,
"root": "footer",
"elements": {
"footer": {
"type": "Box",
"props": {
"direction": "horizontal",
"stackBelow": "sm",
"justify": "between",
"align": "center",
"gap": "md",
"padding": "lg",
"border": "top",
"label": "Footer"
},
"children": ["note", "social"]
},
"note": {
"type": "Text",
"props": { "text": "© 2026 Northwind", "variant": "caption" }
},
"social": {
"type": "Box",
"props": {
"direction": "horizontal",
"gap": "xs",
"label": "Social links"
},
"children": ["github", "linkedin", "youtube"]
},
"github": {
"type": "Button",
"props": {
"label": "GitHub",
"icon": "brand-github",
"iconOnly": true,
"variant": "ghost"
}
},
"linkedin": {
"type": "Button",
"props": {
"label": "LinkedIn",
"icon": "brand-linkedin",
"iconOnly": true,
"variant": "ghost"
}
},
"youtube": {
"type": "Button",
"props": {
"label": "YouTube",
"icon": "brand-youtube",
"iconOnly": true,
"variant": "ghost"
}
}
}
}The mark sits at the start of a Button whose words name the provider.
Show JSONHide JSON
{
"version": 1,
"root": "providers",
"elements": {
"providers": {
"type": "Box",
"props": { "gap": "sm", "maxWidth": "xs" },
"children": ["google", "apple", "github"]
},
"google": {
"type": "Button",
"props": {
"label": "Continue with Google",
"icon": "brand-google",
"variant": "outline",
"fullWidth": true
}
},
"apple": {
"type": "Button",
"props": {
"label": "Continue with Apple",
"icon": "brand-apple",
"variant": "outline",
"fullWidth": true
}
},
"github": {
"type": "Button",
"props": {
"label": "Continue with GitHub",
"icon": "brand-github",
"variant": "outline",
"fullWidth": true
}
}
}
}PropsLink to this section
Generated from the zod schema the server validates with. Unknown props are ignored with a warning. Any prop can also be a dynamic value such as { "$state": "/path" }; it is checked again once it resolves.
| Prop | Type | Limits and defaults |
|---|---|---|
| namerequired | "file-text" | "notes" | "notebook" | "book" | "book-2" | "writing" | "pencil" | "feather" | "quote" | "report" | "presentation" | "clipboard" | "archive" | "folder" | "paperclip" | "link" | "checklist" | "list-check" | "clipboard-list" | "clipboard-check" | "list-details" | "map" | "route" | "target" | "flag" | "compass" | "timeline" | "sitemap" | "hierarchy" | "gavel" | "scale" | "rocket" | "bulb" | "brain" | "search" | "microscope" | "flask" | "school" | "atom" | "language" | "code" | "terminal-2" | "brackets" | "git-branch" | "git-pull-request" | "git-merge" | "api" | "bug" | "puzzle" | "plug" | "tool" | "settings" | "adjustments" | "components" | "layout-dashboard" | "robot" | "package" | "database" | "server" | "cloud" | "cpu" | "table" | "chart-bar" | "chart-line" | "chart-pie" | "chart-dots" | "trending-up" | "stack-2" | "versions" | "calendar" | "calendar-event" | "clock" | "hourglass" | "alarm" | "refresh" | "lock" | "key" | "shield" | "shield-check" | "fingerprint" | "eye" | "users" | "user" | "message-circle" | "mail" | "bell" | "speakerphone" | "lifebuoy" | "circle-check" | "alert-triangle" | "info-circle" | "help-circle" | "ban" | "bolt" | "flame" | "sparkles" | "star" | "heart" | "trophy" | "home" | "building" | "briefcase" | "currency-dollar" | "shopping-cart" | "world" | "palette" | "photo" | "device-laptop" | "device-mobile" | "coffee" | "leaf" | "arrow-right" | "arrow-left" | "arrow-up-right" | "chevron-right" | "chevron-left" | "chevron-down" | "chevron-up" | "check" | "x" | "plus" | "minus" | "menu-2" | "dots" | "external-link" | "download" | "upload" | "send" | "player-play" | "trash" | "copy" | "filter" | "share" | "bookmark" | "tag" | "at" | "phone" | "map-pin" | "credit-card" | "gift" | "truck" | "thumb-up" | "login" | "logout" | "sun" | "moon" | "brand-github" | "brand-gitlab" | "brand-x" | "brand-linkedin" | "brand-youtube" | "brand-instagram" | "brand-facebook" | "brand-tiktok" | "brand-discord" | "brand-mastodon" | "brand-bluesky" | "brand-threads" | "brand-reddit" | "brand-twitch" | "brand-dribbble" | "brand-behance" | "brand-medium" | "brand-apple" | "brand-google" | "brand-windows" | "brand-android" | — |
| size | "xs" | "sm" | "md" | "lg" | "xl" | — |
| tone | "default" | "muted" | "info" | "success" | "warning" | "danger" | "accent" | — |
| label | string | max 80 chars |
RulesLink to this section
nameis one of the listed icon names. An unknown name fails validation.- An icon that carries meaning on its own needs a
label. tone: default, muted, a status tone (info, success, warning, danger), or accent: the theme's own accent, or blue on the default palette. Every tone reads on every Box surface and in every theme.- Brand marks all start with
brand-, such asbrand-githuborbrand-google. They are outline only and drawn in the text color, never in a brand color, and every component that takes an icon name takes them: Icon, Button, Badge, and Link. - Use a brand mark for a link to the brand's profile, or for a "Continue with" button for that provider, and name the brand in the
labelor the words ("GitHub", "Continue with Google"). An icon-only Button needs thatlabel. Do not use a mark as if your own product were that brand.
Children and eventsLink to this section
Icon is a leaf: it does not show children. Validation warns when a leaf has some; wrap them in a Stack or Card instead.
It emits no events.