You are viewing the v1.0.0 documentation.

Icons

Display icons from Lucide, Font Awesome, or custom sources

The Icon component displays icons from various sources including Lucide icons, Font Awesome, and custom images.

Usage

Code
mdx
1<Icon icon="rocket" size={24} color="#3b82f6" />

Live Examples

Lucide Icons

With Colors

Different Sizes

Inline with Text

This task iscomplete!

Want to learn more?Check the docs.

Props

PropTypeDefaultDescription
iconstring | ReactNoderequiredIcon name, URL, or React node
iconTypestring"regular"Font Awesome style (if using FA)
colorstring-Icon color (CSS color value)
sizenumber20Icon size in pixels
classNamestring-Additional CSS classes

Icon Sources

Lucide Icons (Default)

Use kebab-case icon names from Lucide:

Code
mdx
1<Icon icon="arrow-right" />
2<Icon icon="check-circle" />
3<Icon icon="external-link" />

Image URLs

Use any image URL or local path:

Code
mdx
1<Icon icon="/images/logo.svg" size={24} />
2<Icon icon="https://example.com/icon.png" size={24} />

Font Awesome

Prefix icons with fa- to use Font Awesome:

Code
mdx
1<Icon icon="fa-github" iconType="brands" />

Common Icons

IconNameUsage
homeHome/dashboard
settingsConfiguration
userUser profile
searchSearch
plusAdd new
xClose
checkSuccess
alert-triangleWarning