Skip to content

docs: add iconify icon naming convention #4307

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: v3
Choose a base branch
from
Open

docs: add iconify icon naming convention #4307

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 6 additions & 2 deletions docs/content/1.getting-started/4.icons/2.vue.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ You can use the [Icon](/components/icon) component with a `name` prop to display
::component-code{slug="icon"}
---
props:
name: 'i-lucide-lightbulb'
name: 'i-lucide:lightbulb'
class: 'size-5'
---
::
Expand All @@ -32,6 +32,10 @@ props:
You can use any name from the <https://icones.js.org> collection.
::

::warning
You have to separate the icon name from the collection with a colon (`:`). Learn more about the [Iconify naming convention](https://iconify.design/docs/icon-components/vue/#icon).
::

### Component Props

Some components also have an `icon` prop to display an icon, like the [Button](/components/button) for example:
Expand All @@ -42,7 +46,7 @@ ignore:
- color
- variant
props:
icon: i-lucide-sun
icon: i-lucide:sun
variant: subtle
slots:
default: Button
Expand Down
Loading