Skip to content

Commit 8d9ed1a

Browse files
authored
improve setup instructions
i missed that i need the http-client installed, the bundle silently reduces functionality without it. make it more clear what needs to be installed
1 parent e653f48 commit 8d9ed1a

File tree

1 file changed

+21
-9
lines changed

1 file changed

+21
-9
lines changed

src/Icons/doc/index.rst

+21-9
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,18 @@ Installation
1616
1717
$ composer require symfony/ux-icons
1818
19+
If you plan to use provided icon sets, make sure that you have the HTTP client installed:
20+
21+
.. code-block:: terminal
22+
23+
$ composer require symfony/http-client
24+
25+
If you plan to use the optional HTML syntax, also install the ux-twig-component:
26+
27+
.. code-block:: terminal
28+
29+
$ composer require symfony/ux-twig-component
30+
1931
SVG Icons
2032
---------
2133

@@ -63,15 +75,6 @@ Loading Icons
6375
and embeds the downloaded SVG contents in the template #}
6476
{{ ux_icon('flowbite:user-solid') }}
6577
66-
.. note::
67-
68-
To search and download icons via `ux.symfony.com/icons`_, the ``symfony/http-client``
69-
package must be installed in your application:
70-
71-
.. code-block:: terminal
72-
73-
$ composer require symfony/http-client
74-
7578
The ``ux_icon()`` function defines a second optional argument where you can
7679
define the HTML attributes added to the ``<svg>`` element:
7780

@@ -87,6 +90,15 @@ define the HTML attributes added to the ``<svg>`` element:
8790
Icon Sets
8891
~~~~~~~~~
8992

93+
.. note::
94+
95+
To use icons from icon sets via `ux.symfony.com/icons`_, the ``symfony/http-client``
96+
package must be installed in your application:
97+
98+
.. code-block:: terminal
99+
100+
$ composer require symfony/http-client
101+
90102
There are many icon sets available, each with their own unique style and set of
91103
icons, providing a wide range of icons for different purposes, while maintaining
92104
a consistent look and feel across your application. Here are some of the most

0 commit comments

Comments
 (0)