Skip to content

[Icons] Document icon_sets configuration #2938

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.

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
Jul 24, 2025
Merged

Conversation

Kocal
Copy link
Member

@Kocal Kocal commented Jul 24, 2025

Q A
Bug fix? no
New feature? no
Docs? yes
Issues Fix #2182
License MIT

Related to #2156

@carsonbot carsonbot added Icons Status: Needs Review Needs to be reviewed labels Jul 24, 2025
@Kocal Kocal added the docs Improvements or additions to documentation label Jul 24, 2025
Comment on lines +631 to +634
# Icon sets configuration, array of prefix => icon set configuration
icon_sets:
# Icon set for "flags", can be used like this: ux_icon('flags:fr')
flags:
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I didn't add any "added in 2.20", this version is pretty old right now

Copy link
Member

@kbond kbond left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚀

@carsonbot carsonbot added Status: Reviewed Has been reviewed by a maintainer and removed Status: Needs Review Needs to be reviewed labels Jul 24, 2025
@Kocal Kocal merged commit 564cca1 into symfony:2.x Jul 24, 2025
2 checks passed
flags:
It can either be mapped to a local directory...
path: '%kernel.project_dir%/assets/images/flags'
... or to an existing icon set identifier
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
... or to an existing icon set identifier
# ... or to an existing icon set identifier

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixed in #2939, thanks!

icon_sets:
# Icon set for "flags", can be used like this: ux_icon('flags:fr')
flags:
It can either be mapped to a local directory...
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
It can either be mapped to a local directory...
# It can either be mapped to a local directory...

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🤦🏻

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixed in #2939, thanks!

Kocal added a commit to Kocal/symfony-ux that referenced this pull request Jul 25, 2025
Kocal added a commit that referenced this pull request Jul 25, 2025
#2938 (Kocal)

This PR was merged into the 2.x branch.

Discussion
----------

[Icons] Fix `icon_sets` configuration documentation, follow #2938

| Q             | A
| ------------- | ---
| Bug fix?      | no
| New feature?  | no <!-- please update src/**/CHANGELOG.md files -->
| Docs?         | yes <!-- required for new features -->
| Issues        | Fix #... <!-- prefix each issue number with "Fix #", no need to create an issue if none exist, explain below instead -->
| License       | MIT

<!--
Replace this notice by a description of your feature/bugfix.
This will help reviewers and should be a good start for the documentation.

Additionally (see https://symfony.com/releases):
 - Always add tests and ensure they pass.
 - For new features, provide some code snippets to help understand usage.
 - Features and deprecations must be submitted against branch main.
 - Update/add documentation as required (we can help!)
 - Changelog entry should follow https://symfony.com/doc/current/contributing/code/conventions.html#writing-a-changelog-entry
 - Never break backward compatibility (see https://symfony.com/bc).
-->

Following #2938

Commits
-------

f5884b3 [Icons] Fix `icon_sets` configuration documentation, follow #2938
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Improvements or additions to documentation Icons Status: Reviewed Has been reviewed by a maintainer
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Doc] Add docs for the new icon features
4 participants