Skip to content

Commit 15482aa

Browse files
docs(icons): add warning about dash collections in vue (#4307)
Co-authored-by: Benjamin Canac <[email protected]>
1 parent f903ec3 commit 15482aa

File tree

1 file changed

+6
-0
lines changed
  • docs/content/1.getting-started/4.icons

1 file changed

+6
-0
lines changed

docs/content/1.getting-started/4.icons/2.vue.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,12 @@ props:
3232
You can use any name from the <https://icones.js.org> collection.
3333
::
3434

35+
::warning
36+
When using collections with a dash (`-`), you need to separate the icon name from the collection name with a colon (`:`) as `@iconify/vue` does not handle this case like `@nuxt/icon`. For example, instead of `i-simple-icons-github` you need to write `i-simple-icons:github` or `simple-icons:github`.
37+
38+
Learn more about the [Iconify naming convention](https://iconify.design/docs/icon-components/vue/#icon).
39+
::
40+
3541
### Component Props
3642

3743
Some components also have an `icon` prop to display an icon, like the [Button](/components/button) for example:

0 commit comments

Comments
 (0)