Skip to content

Commit 9e7dc71

Browse files
committed
doc updates
1 parent 88b3695 commit 9e7dc71

File tree

1 file changed

+15
-1
lines changed

1 file changed

+15
-1
lines changed

src/Icons/README.md

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,6 +52,17 @@ directory using the `ux:icons:import` command:
5252
bin/console ux:icons:import flowbite:user-solid flowbite:home-solid
5353
```
5454

55+
> [!NOTE]
56+
> Imported icons must be committed to your repository.
57+
58+
#### On-Demand VS Import
59+
60+
While _on-demand_ icons are great during development, they require http requests to fetch the icon
61+
and always use the _latest version_ of the icon. It's possible the icon could change or be removed
62+
in the future. Additionally, the cache warming process will take significantly longer if using
63+
many _on-demand_ icons. You can think of importing the icon as _locking it_ (similar to how
64+
`composer.lock` _locks_ your dependencies).
65+
5566
## Usage
5667

5768
```twig
@@ -91,6 +102,9 @@ This command looks in all your twig templates for `ux_icon` calls and caches the
91102
> During development, if you modify an icon, you will need to clear the cache (`bin/console cache:clear`)
92103
> to see the changes.
93104
105+
> [!TIP]
106+
> If using `symfony/asset-mapper`, the cache is warmed automatically when running `asset-map:compile`.
107+
94108
## Full Default Configuration
95109

96110
```yaml
@@ -103,7 +117,7 @@ ux_icons:
103117
# Default:
104118
fill: currentColor
105119

106-
# Configuration for the Iconify.design functionality.
120+
# Configuration for the "on demand" icons powered by Iconify.design.
107121
iconify:
108122
enabled: true
109123

0 commit comments

Comments
 (0)