@@ -3,9 +3,9 @@ Symfony UX Icons
3
3
4
4
The ``symfony/ux-icons `` package offers simple and intuitive ways to render
5
5
SVG icons in your Symfony application. It provides a Twig function to include
6
- any local or remote icons from your templates.
6
+ both local and remote icons in your templates.
7
7
8
- UX Icons gives you a direct access to over 200,000 vector icons from popular
8
+ UX Icons gives you direct access to over 200,000 vector icons from popular
9
9
icon sets such as FontAwesome, Bootstrap Icons, Tabler Icons, Google Material
10
10
Design Icons, etc.
11
11
@@ -16,14 +16,8 @@ Installation
16
16
17
17
$ composer require symfony/ux-icons
18
18
19
- HTTP Client for On-Demand Icons
20
- ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
21
-
22
- If you plan to use provided icon sets, make sure that you have the HTTP client installed:
23
-
24
- .. code-block :: terminal
25
-
26
- $ composer require symfony/http-client
19
+ # To use provided on-demand icon sets, you also need HTTP client:
20
+ $ composer require symfony/http-client
27
21
28
22
SVG Icons
29
23
---------
@@ -39,7 +33,7 @@ your own.
39
33
Icon Names
40
34
~~~~~~~~~~
41
35
42
- Icons are referenced using an unique identifier that follows one of the following syntaxes:
36
+ Icons are referenced using a unique identifier using one of the following syntaxes:
43
37
44
38
* ``prefix:name `` (e.g. ``mdi:check ``, ``bi:check ``, ``editor:align-left ``)
45
39
* ``name `` only (e.g. ``check ``, ``close ``, ``menu ``)
@@ -50,7 +44,7 @@ The icon ``name`` is the same as the file name without the file extension (e.g.
50
44
51
45
The name must match a standard ``slug `` format: ``[a-z0-9-]+(-[a-z0-9])+ ``.
52
46
53
- Depending on your configuration, the ``prefix `` can be the name of an icon set, a directory
47
+ Depending on your ` configuration `_ , the ``prefix `` can be the name of an icon set, a directory
54
48
where the icon is located, or a combination of both.
55
49
56
50
For example, the ``bi `` prefix refers to the Bootstrap Icons set, while the ``header `` prefix
@@ -547,7 +541,7 @@ returning the HTML output.
547
541
Configuration
548
542
-------------
549
543
550
- The UX Icons integrates seamlessly in Symfony applications. All these options are configured under
544
+ The UX Icons component integrates seamlessly in Symfony applications. All these options are configured under
551
545
the ``ux_icons `` key in your application configuration.
552
546
553
547
.. code-block :: yaml
0 commit comments