Skip to content

Commit

Permalink
minor #2226 [UX Icons] Some updates in the full configuration example…
Browse files Browse the repository at this point in the history
… docs (javiereguiluz)

This PR was squashed before being merged into the 2.x branch.

Discussion
----------

[UX Icons] Some updates in the full configuration example docs

| Q             | A
| ------------- | ---
| Bug fix?      | no
| New feature?  | no
| Issues        | - below instead -->
| License       | MIT

I propose to also show some options with problematic characters in their names (`:`, `-`) to let readers know how to use them.

Commits
-------

4a07c66 [UX Icons] Some updates in the full configuration example docs
  • Loading branch information
javiereguiluz committed Oct 1, 2024
2 parents 3592e6d + 4a07c66 commit d72aa7e
Showing 1 changed file with 9 additions and 9 deletions.
18 changes: 9 additions & 9 deletions src/Icons/doc/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -541,30 +541,30 @@ Full Configuration
# config/packages/ux_icons.yaml
ux_icons:
# The local directory where icons are stored.
# The local directory where icons are stored
icon_dir: '%kernel.project_dir%/assets/icons'
# Default attributes to add to all icons.
# Default attributes to add to all icons
default_icon_attributes:
# Default:
fill: currentColor
'font-size': '1.25em'
# Icon aliases (alias => icon name).
# Icon aliases (alias => icon name)
aliases:
# Exemple:
dots: 'clarity:ellipsis-horizontal-line'
'tabler:save': 'tabler:device-floppy'
# Configuration for the "on demand" icons powered by Iconify.design.
# Configuration for the "on demand" icons powered by Iconify.design
iconify:
enabled: true
# Whether to use the "on demand" icons powered by Iconify.design.
# Whether to use the "on demand" icons powered by Iconify.design
on_demand: true
# The endpoint for the Iconify API.
# The endpoint for the Iconify API
endpoint: 'https://api.iconify.design'
# Whether to ignore errors when an icon is not found.
# Whether to ignore errors when an icon is not found
ignore_not_found: false
Learn more
Expand Down

0 comments on commit d72aa7e

Please sign in to comment.