#Usage
Browse icons registered in the docs app (docs/icons.ts).
Icons below are loaded from packages/ui/docs/icons.ts and passed to app.use(UI, { icons }) in the docs app. See the Icons guide to build your own set.
activity
align-justify
align-left
align-right
arrow-left
arrow-right
bar-chart-2
bold
book
check
check-circle
chevron-down
chevron-left
chevron-right
chevron-up
code
copy
cube
edit
external-link
forward
fullsvg
github
heart
image
italic
link
list
mail
map-pin
menu
menu-alt-1
menu-alt-3
moon
more-horizontal
nuxt
palette
pause
play
plus
refresh-cw
rewind
rotate-ccw
rss
search
shield
smile
sparkles
star
star-half
sun
trash
trending-up
truck
twitter
type
upload
users
vue
wrench
x
x-circle
x-octagon
#Formats
Registry keys, full SVG strings, raw paths, and filled object configs.
Registry key
Reference a name from your icons map.
icon="github"Full SVG string
Paste a complete <svg> element; attributes are applied automatically.
icon="fullsvg"Raw path markup
Pass path/polyline markup directly when the icon is not in the registry.
<polyline …>Filled icons (object config)
Use { icon, filled, viewBox } in the registry for multi-color or filled shapes.
vue
nuxt
play
#API
Icon
props
Name | Description | Type | Default | Values | Required |
|---|---|---|---|---|---|
size | Control size. One of xs, sm, md, lg, xl. | String | md | xssmmdlgxl | |
icon | Icon name from the injected icon set, or raw SVG path markup. | String | true | ||
filled | Renders a filled icon instead of an outline stroke. | Boolean | false | ||
viewBox | SVG viewBox when rendering path markup. | String | 0 0 24 24 |