[UX3] Start an UPGRADE file #3056
+87
−0
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|
| @@ -0,0 +1,87 @@ | ||||||||||
| # UPGRADE FROM `2.x` TO `3.0` | ||||||||||
|
|
||||||||||
| Symfony UX follows Symfony's release system. This means that major | ||||||||||
| versions (like `3.0`) offer the same functionality as their previous minor | ||||||||||
| versions (like `2.x`), once all deprecations have been removed. | ||||||||||
|
|
||||||||||
| However, major versions may also introduce new features and improvements, and a | ||||||||||
| bump in the required PHP or packages versions. | ||||||||||
|
|
||||||||||
| --- | ||||||||||
|
|
||||||||||
| ## Table of Contents | ||||||||||
|
|
||||||||||
| * [Requirements](#requirements) | ||||||||||
| * [UX 3.0](#ux-30) | ||||||||||
| * [UX 3.x](#ux-3x) | ||||||||||
| * [Packages](#packages) | ||||||||||
| * [Twig Component](#twig-component) | ||||||||||
| * [Removed Packages](#removed-packages) | ||||||||||
| * [LazyImage (removed)](#lazyimage-removed) | ||||||||||
| * [Swup (removed)](#swup-removed) | ||||||||||
| * [TogglePassword (removed)](#togglepassword-removed) | ||||||||||
| * [Typed (removed)](#typed-removed) | ||||||||||
|
Comment on lines
+12
to
+23
There was a problem hiding this comment. Not useful, GitHub already generates a ToC |
||||||||||
|
|
||||||||||
| --- | ||||||||||
|
|
||||||||||
| ## Requirements | ||||||||||
|
|
||||||||||
| ### UX 3.0 | ||||||||||
|
|
||||||||||
| - Requires PHP `8.1` or higher. | ||||||||||
| - Requires Symfony `6.4` or higher. | ||||||||||
|
Comment on lines
+27
to
+32
There was a problem hiding this comment. Could be changed to a |
||||||||||
|
|
||||||||||
| ### UX 3.x | ||||||||||
|
|
||||||||||
| - New features or packages introduced in future `3.x` releases may require | ||||||||||
| higher versions of PHP (e.g. `8.2`, `8.3`) and/or Symfony (e.g. `7.x`). | ||||||||||
|
|
||||||||||
| [[Back to top]](#table-of-contents) | ||||||||||
|
Comment on lines
+34
to
+39
|
||||||||||
|
|
||||||||||
| --- | ||||||||||
|
|
||||||||||
| ## Packages | ||||||||||
|
|
||||||||||
| ### Twig Component | ||||||||||
|
Comment on lines
+43
to
+45
There was a problem hiding this comment. Let's remove headings
Suggested change
There was a problem hiding this comment. (and move |
||||||||||
|
|
||||||||||
| - Install `twig/html-extra` if you are using the `cva` function. You may need | ||||||||||
| to update the signature of the `cva()` Twig function in your templates to | ||||||||||
| match the new signature. | ||||||||||
|
|
||||||||||
| [[Back to top]](#table-of-contents) | ||||||||||
|
There was a problem hiding this comment. Not useful, GitHub already generates a ToC |
||||||||||
|
|
||||||||||
| --- | ||||||||||
|
|
||||||||||
| ## Removed Packages | ||||||||||
|
|
||||||||||
| > [!IMPORTANT] | ||||||||||
| > The packages deprecated in `2.x` and have been removed in `3.0`. | ||||||||||
| > | ||||||||||
| > They remain usable in the `2.x` branch, but should be avoided in new projects, | ||||||||||
| > as they will not be maintained going forward. See below for details. | ||||||||||
|
|
||||||||||
|
Comment on lines
+55
to
+62
|
||||||||||
| ### LazyImage (removed) | ||||||||||
|
There was a problem hiding this comment. No need to suffix by
Suggested change
|
||||||||||
|
|
||||||||||
| * Deprecated in `2.x` and **removed in `3.0`**. Use the native `loading="lazy"` | ||||||||||
| attribute on `<img>` elements instead. See the [previous README](https://raw.githubusercontent.com/symfony/ux/refs/heads/2.x/src/LazyImage/README.md) | ||||||||||
| for reference. | ||||||||||
|
|
||||||||||
| ### Swup (removed) | ||||||||||
|
|
||||||||||
| * Deprecated in `2.x` and **removed in `3.0`**. Use Turbo and CSS-based page | ||||||||||
| transitions instead. See the [previous README](https://raw.githubusercontent.com/symfony/ux/refs/heads/2.x/src/Swup/README.md) | ||||||||||
| for reference. | ||||||||||
|
|
||||||||||
| ### TogglePassword (removed) | ||||||||||
|
|
||||||||||
| * Deprecated in `2.x` and **removed in `3.0`**. Use a custom user-land | ||||||||||
| implementation instead. See the [previous README](https://raw.githubusercontent.com/symfony/ux/refs/heads/2.x/src/TogglePassword/README.md) | ||||||||||
| for reference. | ||||||||||
|
|
||||||||||
| ### Typed (removed) | ||||||||||
|
|
||||||||||
| * Deprecated in `2.x` and **removed in `3.0`**. Use a custom user-land | ||||||||||
| implementation instead. See the [previous README](https://raw.githubusercontent.com/symfony/ux/refs/heads/2.x/src/Typed/README.md) | ||||||||||
| for reference. | ||||||||||
|
|
||||||||||
| [[Back to top]](#table-of-contents) | ||||||||||
|
|
||||||||||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
noneed to be superfluous: