Icon
An icon puts a small glyph in your text, with an optional word beside it. The same names work anywhere that takes an icon, such as cards, sidebar folders and tabs.
Example
Launch Guides Authentication
<Icon name="rocket">Launch</Icon> <Icon name="book-open">Guides</Icon> <Icon name="key">Authentication</Icon>Props
namestringrequiredThe glyph, from the names below. It's forgiving about how it's written: case doesn't matter, spaces and underscores count as hyphens, and the hyphens themselves are optional, so Book Open, book_open and bookopen all draw book-open. An unknown name draws nothing, rather than a broken glyph.
childrentextA word or two drawn beside the glyph. Leave the tags empty for the glyph alone.
Every name
activity alert-circle alert-triangle archive arrow-right arrow-up-right award bar-chart battery bell-off bell-ring bell blocks bolt book-marked book-open book bookmark box boxes braces briefcase bug building-2 calendar-days calendar camera check-check check-circle check chevron-down chevron-right clipboard clock cloud code-2 code coffee columns command compass copy cpu credit-card database dollar-sign download edit external-link eye-off eye file-code file-json file-text file filter-x filter fingerprint flag flame folder-open folder-tree folder gauge gift git-branch git-commit git-pull-request github globe graduation-cap grid-3x3 grid hammer hard-drive hash heart help-circle history home hourglass image inbox info key-round key layers layout lightbulb link list loader-circle lock-keyhole lock log-in log-out mail map-pin map maximize megaphone menu message-circle mic minimize minus moon more-horizontal navigation newspaper package-check package panel-left paperclip pause pencil percent phone pin play plug plus power qr-code quote radar refresh repeat rocket rows rss save scan scissors scroll search send server settings-2 settings share shield-alert shield-check shield shopping-cart skip-forward sliders-vertical sliders smile sparkles star store sun table tag target terminal thumbs-down thumbs-up timer toggle trash trending-up truck type unlock upload user-check user-plus user-x user users video volume-2 wallet wand webhook wifi workflow wrench x-circle zap-off zap
Other names that work
Common words resolve to the closest glyph, so you rarely need to look one up. A few of them:
| You write | You get |
|---|---|
gear, cog, config | settings |
docs, guide | book |
reference, tutorial | book-open |
api | code |
auth, authentication | key |
security | shield |
db, data | database |
email, envelope | mail |
chat, comment, message | message-circle |
warning, alert | alert-triangle |
error | x-circle |
tip, idea | lightbulb |
launch, quickstart | rocket |
delete, remove | trash |
pricing, money | dollar-sign |
payment | credit-card |
repo, git, branch | git-branch |
analytics | activity |
world, web | globe |