Skip to content

Fix Icon documentation #309

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
Jeremy-Walton wants to merge 2 commits into
base: main
Choose a base branch
from
+6 −5
Open

Fix Icon documentation #309

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b574870
fix icon paths in the addon mdx
dominicmacaulay Feb 13, 2025
c26829e
Update feather/lucide descriptions
dominicmacaulay Feb 13, 2025
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
5 changes: 3 additions & 2 deletions src/stories/Components/Icon/Icon.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -126,12 +126,13 @@ The size modifiers can be used with Feather Icons.
<i class="icon fi fi-feather icon--x-large"></i>
```

Note: Feather Icons do not support the use of filled, weight, or emphasis variations.
Note: Feather Icons do not support the use of filled, weight, or emphasis variations. The Feather Icon CDN does not include all of the Feather Icons.
If you want access to the broader range of Feather Icons, consider using Lucide Icons instead. However, if your needs are not as extensive or you are looking for a smaller icon pack, Feather Icons may be a better choice.

### Lucide Icons

Lucide Icons are a fork of Feather Icons with more icons. If you don't need all the icons that Lucide provides,
you can use the Feather Icons for a smaller icon pack instead.
you can use the Feather Icons for a smaller icon pack instead. It is important to note that Feather Icons are less supported and not all of the listed icons are available.

[Lucide Icons](https://lucide.dev/icons/) can be created with the `<i>` tag and uses the `.li` prefix with `.li-{name}` to define a specific icon.

Expand Down
6 changes: 3 additions & 3 deletions src/stories/Overview/Addons.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,13 +47,13 @@ For more information on how to use these icons, see the [Icon Component](?path=/
@import '@rolemodel/optics/dist/css/addons/fonts/phosphor_icons';

/* Tabler Icons */
@import '@rolemodel/optics/dist/css/addons/fonts/tabler';
@import '@rolemodel/optics/dist/css/addons/fonts/tabler_icons';

/* Feather Icons */
@import '@rolemodel/optics/dist/css/addons/fonts/feather';
@import '@rolemodel/optics/dist/css/addons/fonts/feather_icons';

/* Lucide Icons (a fork of feather with more icons) */
@import '@rolemodel/optics/dist/css/addons/fonts/lucide';
@import '@rolemodel/optics/dist/css/addons/fonts/lucide_icons';
```

## Tom Select
Expand Down