Skip to content

[Icons] Some doc updates #1602

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Mar 25, 2024
Merged

[Icons] Some doc updates #1602

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 14 additions & 9 deletions src/Icons/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,20 +1,21 @@
# UX Icons

Renders local and remote SVG icons in your Twig templates.
Renders local and remote [SVG icons](https://ux.symfony.com/icons) in your Twig templates.

```twig
{{ ux_icon('mdi:symfony', {class: 'w-4 h-4'}) }}
{# or #}
{# Twig function.. #}
{{ ux_icon('mdi:check', {class: 'w-4 h-4'}) }}

{# .. or Twig Component #}
<twig:UX:Icon name="mdi:check" class="w-4 h-4" />

{# renders as: #}
<svg viewBox="0 0 24 24" fill="currentColor" class="w-4 h-4"><path fill="currentColor" d="M21 7L9 19l-5.5-5.5l1.41-1.41L9 16.17L19.59 5.59z"/></svg>
{# Render the "check" icon from "mdi" pack with class #}
<svg viewBox="0 0 24 24" fill="currentColor" class="w-4 h-4">
<path d="M21 7L9 19l-5.5-5.5l1.41-1.41L9 16.17L19.59 5.59z"/>
</svg>
```

Want a demo? Check out https://ux.symfony.com/icons.

**This repository is a READ-ONLY sub-tree split**. See
https://github.com/symfony/ux to create issues or submit pull requests.
Check out [ux.symfony.com/icons](https://ux.symfony.com/icons) for a demo!

## Sponsor

Expand All @@ -28,6 +29,10 @@ infrastructure for you!

Help Symfony by [sponsoring][3] its development!

> [!IMPORTANT]
> **This repository is a READ-ONLY sub-tree split**.\
> See https://github.com/symfony/ux to create issues or submit pull requests.

## Resources

- [Documentation](https://symfony.com/bundles/ux-icons/current/index.html)
Expand Down
Loading