Skip to content

[Icons] add versionadded for Icon Aliases to doc #2163

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
Sep 14, 2024
Merged

[Icons] add versionadded for Icon Aliases to doc #2163

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
10 changes: 7 additions & 3 deletions src/Icons/doc/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -339,6 +339,10 @@ Now, all icons will have the ``fill`` attribute set to ``currentColor`` by defau
Icon Aliases
~~~~~~~~~~~~

.. versionadded:: 2.20

Icon Aliases feature was added in 2.20.

Aliases are custom names you can define to refer to any icon. They are useful for
creating shortcuts to icons you frequently use in your templates:

Expand Down Expand Up @@ -544,11 +548,11 @@ Full Configuration
default_icon_attributes:
# Default:
fill: currentColor

# Icon aliases (alias => icon name).
aliases:
# Exemple:
dots: 'clarity:ellipsis-horizontal-line'
dots: 'clarity:ellipsis-horizontal-line'

# Configuration for the "on demand" icons powered by Iconify.design.
iconify:
Expand All @@ -559,7 +563,7 @@ Full Configuration

# The endpoint for the Iconify API.
endpoint: 'https://api.iconify.design'

# Whether to ignore errors when an icon is not found.
ignore_not_found: false

Expand Down