Skip to content

Commit bb13764

Browse files
committed
minor #2793 [Icons] Docs: Merging code blocks; language improvements (ThomasLandauer)
This PR was squashed before being merged into the 2.x branch. Discussion ---------- [Icons] Docs: Merging code blocks; language improvements | Q | A | ------------- | --- | Bug fix? | no | New feature? | no | Docs? | yes | Issues | | License | MIT Page: https://symfony.com/bundles/ux-icons/current/index.html#installation Commits ------- 9a82d3e [Icons] Docs: Merging code blocks; language improvements
2 parents aa383ed + 9a82d3e commit bb13764

File tree

1 file changed

+7
-13
lines changed

1 file changed

+7
-13
lines changed

src/Icons/doc/index.rst

Lines changed: 7 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,9 @@ Symfony UX Icons
33

44
The ``symfony/ux-icons`` package offers simple and intuitive ways to render
55
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.
77

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
99
icon sets such as FontAwesome, Bootstrap Icons, Tabler Icons, Google Material
1010
Design Icons, etc.
1111

@@ -16,14 +16,8 @@ Installation
1616
1717
$ composer require symfony/ux-icons
1818
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
2721
2822
SVG Icons
2923
---------
@@ -39,7 +33,7 @@ your own.
3933
Icon Names
4034
~~~~~~~~~~
4135

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:
4337

4438
* ``prefix:name`` (e.g. ``mdi:check``, ``bi:check``, ``editor:align-left``)
4539
* ``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.
5044

5145
The name must match a standard ``slug`` format: ``[a-z0-9-]+(-[a-z0-9])+``.
5246

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
5448
where the icon is located, or a combination of both.
5549

5650
For example, the ``bi`` prefix refers to the Bootstrap Icons set, while the ``header`` prefix
@@ -547,7 +541,7 @@ returning the HTML output.
547541
Configuration
548542
-------------
549543

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
551545
the ``ux_icons`` key in your application configuration.
552546

553547
.. code-block:: yaml

0 commit comments

Comments
 (0)