Skip to content

Commit

Permalink
minor #2501 [Doc] Add a warning message to not recommend Lazy Image p…
Browse files Browse the repository at this point in the history
…ackage (javiereguiluz)

This PR was merged into the 2.x branch.

Discussion
----------

[Doc] Add a warning message to not recommend Lazy Image package

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

Related to #2004. If we don't deprecate the package, at least warn users that it's no longer recommended. Thanks.

Commits
-------

519c4ce [Doc] Add a warning message to not recommend Lazy Image package
  • Loading branch information
Kocal committed Jan 16, 2025
2 parents b4b3ff3 + 519c4ce commit 562c079
Showing 1 changed file with 7 additions and 0 deletions.
7 changes: 7 additions & 0 deletions src/LazyImage/doc/index.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,12 @@
Symfony UX LazyImage
====================

.. warning::

**This package is no longer recommended.** Instead, use the
`modern techniques to improve image loading performance`_ natively supported
by all major browsers.

Symfony UX LazyImage is a Symfony bundle providing utilities to improve
image loading performance. It is part of `the Symfony UX initiative`_.

Expand Down Expand Up @@ -245,6 +251,7 @@ This bundle aims at following the same Backward Compatibility promise as
the Symfony framework:
https://symfony.com/doc/current/contributing/code/bc.html

.. _`modern techniques to improve image loading performance`: https://web.dev/learn/images/performance-issues
.. _`the Symfony UX initiative`: https://ux.symfony.com/
.. _`BlurHash implementation`: https://blurha.sh
.. _`StimulusBundle`: https://symfony.com/bundles/StimulusBundle/current/index.html
Expand Down

0 comments on commit 562c079

Please sign in to comment.