Keyboard shortcuts

Press ← or → to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Icons

The framework ships 197 icons. Name one in any descriptor that takes an icon: a settings item, a navigation entry, a resource.

SettingsItem::new("acme.blog", "Blog", fields).icon("newspaper")

An unknown name is refused when the application boots, with the nearest matches suggested, so a typo is caught before anybody sees a wrong glyph.

Adding one that is not here

The set is curated rather than exhaustive: upstream ships over two thousand glyphs, and shipping all of them would cost every consumer to serve almost nobody. A plugin registers what it needs:

registry.add_icon(IconReg::new(
    "map-pin-house",
    include_str!("../assets/icons/map-pin-house.svg"),
));

It is namespaced to your module automatically, so two plugins cannot collide, and you reference it as vendor.package:map-pin-house.

Flags

Fillable icons are closed shapes that read correctly filled, which is how a state is shown: a filled star means favourited. Filling is a render option, never part of the name, so there is no star-solid.

Mirrored icons flip under a right-to-left layout because their direction carries meaning. A clock does not mirror; a chevron does.

chrome (48)

Name
arrow-up-downmirrors in RTL
check
chevron-down
chevron-leftmirrors in RTL
chevron-rightmirrors in RTL
chevron-up
chevrons-leftmirrors in RTL
chevrons-rightmirrors in RTL
circle-alert
circle-checkfillable
circle-help
circle-x
columns-3
copy
download
ellipsis
ellipsis-vertical
external-linkmirrors in RTL
eye
eye-off
funnel
grip-vertical
history
info
layout-dashboard
layout-grid
listmirrors in RTL
loader-circle
log-inmirrors in RTL
log-outmirrors in RTL
menu
monitor
moon
panel-leftmirrors in RTL
pencil
plus
redo-2mirrors in RTL
refresh-cw
save
search
settings
sliders-horizontal
sun
trash-2
triangle-alert
undo-2mirrors in RTL
upload
x

people (12)

Name
contact
fingerprint
id-card
key
lock
lock-open
shield
shield-check
user
user-plus
user-round
users

content (34)

Name
bold
book-open
bookmarkfillable
braces
code
file
file-text
files
film
flagfillable
folder
folder-open
folder-plus
heading
heartfillable
image
images
italic
link
list-orderedmirrors in RTL
music
newspaper
notebook-pen
notepad-text
paperclip
pinfillable
quotemirrors in RTL
square-pen
starfillable
tag
tags
type
underline
unlink

communication (11)

Name
at-sign
bellfillable
bell-off
bell-ring
mail
megaphone
message-circle
message-square
phone
rss
sendmirrors in RTL

commerce (25)

Name
badge-percent
banknote
briefcase
building
building-2
calculator
chart-bar
chart-line
chart-pie
coins
credit-card
gift
landmark
package
percent
receipt
scale
shopping-bag
shopping-cart
store
ticket
trending-downmirrors in RTL
trending-upmirrors in RTL
truck
wallet

time-place (12)

Name
alarm-clock
calendar
calendar-days
clock
compass
globe
home
map
map-pin
map-pinned
navigation
timer

technical (27)

Name
bluetooth
bot
bug
camera
cloud
cloud-download
cloud-upload
cpu
database
git-branch
hard-drive
laptop
mic
plug
printer
qr-code
server
smartphone
sparkles
tablet
terminal
video
wand-sparkles
webhook
wifi
workflow
zap

objects (28)

Name
activity
award
blocks
box
boxes
brush
check-checkfillable
circlefillable
component
crown
droplet
flame
gauge
hammer
layers
layout-template
leaf
lightbulb
paintbrush
palette
puzzle
rocket
squarefillable
square-checkfillable
target
trianglefillable
trophy
wrench