|
2 | 2 |
|
3 | 3 | Symfony UX follows Symfony's release process, 2.x and 3.0 have the same features, but Symfony UX 3.0 doesn't include any deprecated features. To upgrade, make sure to resolve all deprecation notices. Read more about this in the [Symfony documentation](https://symfony.com/doc/6.4/setup/upgrade_major.html#upgrade-major-symfony-deprecations).
|
4 | 4 |
|
5 |
| -However, major versions may also introduce new features and improvements, and a |
6 |
| -bump in the required PHP or packages versions. |
7 |
| - |
8 |
| ---- |
9 |
| - |
10 |
| -## Table of Contents |
11 |
| - |
12 |
| -* [Requirements](#requirements) |
13 |
| - * [UX 3.0](#ux-30) |
14 |
| - * [UX 3.x](#ux-3x) |
15 |
| -* [Packages](#packages) |
16 |
| - * [Twig Component](#twig-component) |
17 |
| -* [Removed Packages](#removed-packages) |
18 |
| - * [LazyImage (removed)](#lazyimage-removed) |
19 |
| - * [Swup (removed)](#swup-removed) |
20 |
| - * [TogglePassword (removed)](#togglepassword-removed) |
21 |
| - * [Typed (removed)](#typed-removed) |
22 |
| - |
23 |
| ---- |
24 |
| - |
25 |
| -## Requirements |
26 |
| - |
27 |
| -### UX 3.0 |
28 |
| - |
29 |
| -- Requires PHP `8.1` or higher. |
30 |
| -- Requires Symfony `6.4` or higher. |
31 |
| - |
32 |
| -### UX 3.x |
33 |
| - |
34 |
| -- New features or packages introduced in future `3.x` releases may require |
35 |
| - higher versions of PHP (e.g. `8.2`, `8.3`) and/or Symfony (e.g. `7.x`). |
36 |
| - |
37 |
| -[[Back to top]](#table-of-contents) |
38 |
| - |
39 |
| ---- |
40 |
| - |
41 |
| -## Packages |
42 |
| - |
43 |
| -### Twig Component |
44 |
| - |
45 |
| -- Install `twig/html-extra` if you are using the `cva` function. You may need |
46 |
| - to update the signature of the `cva()` Twig function in your templates to |
47 |
| - match the new signature. |
48 |
| - |
49 |
| -[[Back to top]](#table-of-contents) |
50 |
| - |
51 |
| ---- |
52 |
| - |
53 |
| -## Removed Packages |
54 |
| - |
55 |
| -> [!IMPORTANT] |
56 |
| -> The packages deprecated in `2.x` and have been removed in `3.0`. |
| 5 | +> [!NOTE] |
| 6 | +> Requires PHP `8.2` or higher. |
57 | 7 | >
|
58 |
| -> They remain usable in the `2.x` branch, but should be avoided in new projects, |
59 |
| -> as they will not be maintained going forward. See below for details. |
| 8 | +> Requires Symfony `6.4` or higher. |
60 | 9 |
|
61 |
| -### LazyImage (removed) |
| 10 | +## LazyImage |
62 | 11 |
|
63 | 12 | * Deprecated in `2.x` and **removed in `3.0`**. Use the native `loading="lazy"`
|
64 | 13 | attribute on `<img>` elements instead. See the [previous README](https://raw.githubusercontent.com/symfony/ux/refs/heads/2.x/src/LazyImage/README.md)
|
65 | 14 | for reference.
|
66 | 15 |
|
67 |
| -### Swup (removed) |
| 16 | +## Swup |
68 | 17 |
|
69 | 18 | * Deprecated in `2.x` and **removed in `3.0`**. Use Turbo and CSS-based page
|
70 | 19 | transitions instead. See the [previous README](https://raw.githubusercontent.com/symfony/ux/refs/heads/2.x/src/Swup/README.md)
|
71 | 20 | for reference.
|
72 | 21 |
|
73 |
| -### TogglePassword (removed) |
| 22 | +## TogglePassword |
74 | 23 |
|
75 | 24 | * Deprecated in `2.x` and **removed in `3.0`**. Use a custom user-land
|
76 | 25 | implementation instead. See the [previous README](https://raw.githubusercontent.com/symfony/ux/refs/heads/2.x/src/TogglePassword/README.md)
|
77 | 26 | for reference.
|
78 | 27 |
|
79 |
| -### Typed (removed) |
| 28 | +## Twig Component |
| 29 | + |
| 30 | +* Install `twig/html-extra` if you are using the `cva` function. You may need |
| 31 | + to update the signature of the `cva()` Twig function in your templates to |
| 32 | + match the new signature. |
| 33 | + |
| 34 | +## Typed |
80 | 35 |
|
81 | 36 | * Deprecated in `2.x` and **removed in `3.0`**. Use a custom user-land
|
82 | 37 | implementation instead. See the [previous README](https://raw.githubusercontent.com/symfony/ux/refs/heads/2.x/src/Typed/README.md)
|
83 | 38 | for reference.
|
84 |
| - |
85 |
| -[[Back to top]](#table-of-contents) |
0 commit comments