Skip to content

Commit 5c17b26

Browse files
committed
Minor tweaks in the docs
1 parent 38e685d commit 5c17b26

File tree

1 file changed

+9
-6
lines changed

1 file changed

+9
-6
lines changed

src/Icons/doc/index.rst

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -339,14 +339,14 @@ Now, all icons will have the ``fill`` attribute set to ``currentColor`` by defau
339339
Icon Aliases
340340
~~~~~~~~~~~~
341341

342-
You can define aliases for icons in your configuration, which is helpful if
343-
you want to use a different or shorter name for an icon in your templates:
342+
Aliases are custom names you can define to refer to any icon. They are useful for
343+
creating shortcuts to icons you frequently use in your templates:
344344

345345
.. code-block:: yaml
346346
347347
# config/packages/ux_icons.yaml
348348
ux_icons:
349-
349+
# ...
350350
aliases:
351351
dots: 'clarity:ellipsis-horizontal-line'
352352
@@ -355,11 +355,14 @@ Now, you can use the ``dots`` alias in your templates:
355355
.. code-block:: twig
356356
357357
{{ ux_icon('dots') }}
358-
359-
{# same as #}
360-
358+
{# with the previous configuration, this is the same as: #}
361359
{{ ux_icon('clarity:ellipsis-horizontal-line') }}
362360
361+
{# using the HTML syntax #}
362+
<twig:ux:icon name="dots" />
363+
{# same as: #}
364+
<twig:ux:icon name="clarity:ellipsis-horizontal-line" />
365+
363366
Errors
364367
------
365368

0 commit comments

Comments
 (0)