Skip to content

Commit 551d269

Browse files
committed
[DOCS][UX3] Start an UPGRADE file
We can either work with branch or merge it in the 3.x branch (and then update it along the way) I'd rather do the "merge" one but open to opinions here along the wa
1 parent 0bc6bbc commit 551d269

File tree

1 file changed

+87
-0
lines changed

1 file changed

+87
-0
lines changed

UPGRADE-3.0.md

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

0 commit comments

Comments
 (0)