You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
minor #2612 Document src/**/assets/README.md files about direct installation and recommended alternatives. (Kocal)
This PR was squashed before being merged into the 2.x branch.
Discussion
----------
Document `src/**/assets/README.md` files about direct installation and recommended alternatives.
| Q | A
| ------------- | ---
| Bug fix? | no
| New feature? | no <!-- please update src/**/CHANGELOG.md files -->
| Issues | Fix #... <!-- prefix each issue number with "Fix #", no need to create an issue if none exist, explain below instead -->
| License | MIT
<!--
Replace this notice by a description of your feature/bugfix.
This will help reviewers and should be a good start for the documentation.
Additionally (see https://symfony.com/releases):
- Always add tests and ensure they pass.
- For new features, provide some code snippets to help understand usage.
- Features and deprecations must be submitted against branch main.
- Changelog entry should follow https://symfony.com/doc/current/contributing/code/conventions.html#writing-a-changelog-entry
- Never break backward compatibility (see https://symfony.com/bc).
-->
Follow #2595, related to #2575
Commits
-------
9a4acb1 [CI] Do not run `test` workflow if only `src/**/*.md` files have been modified
d49923b Document `src/**/assets/README.md` files about direct installation and recommended alternatives.
Copy file name to clipboardExpand all lines: src/Autocomplete/assets/README.md
+3-1
Original file line number
Diff line number
Diff line change
@@ -2,7 +2,9 @@
2
2
3
3
Javascript-powered auto-completion functionality for your Symfony forms!
4
4
5
-
**This package can't be used on its own, and requires the PHP package [symfony/ux-autocomplete](https://github.com/symfony/ux/tree/2.x/src/Autocomplete).**
5
+
**ℹ️ Direct installation of this package is for advanced users only.** We strongly recommend installing it through the PHP package [symfony/ux-autocomplete](https://packagist.org/packages/symfony/ux-autocomplete) in a Symfony application with Flex enabled.
6
+
7
+
If you still want to install this package directly, **make sure its version exactly matches [symfony/ux-autocomplete](https://packagist.org/packages/symfony/ux-autocomplete) PHP package version.**
Copy file name to clipboardExpand all lines: src/Chartjs/assets/README.md
+4-2
Original file line number
Diff line number
Diff line change
@@ -2,11 +2,13 @@
2
2
3
3
Chart.js integration for Symfony.
4
4
5
-
**This package can't be used on its own, and requires the PHP package [symfony/ux-chartjs](https://github.com/symfony/ux/tree/2.x/src/Chartjs).**
5
+
**ℹ️ Direct installation of this package is for advanced users only.** We strongly recommend installing it through the PHP package [symfony/ux-chartjs](https://packagist.org/packages/symfony/ux-chartjs) in a Symfony application with Flex enabled.
6
+
7
+
If you still want to install this package directly, **make sure its version exactly matches [symfony/ux-chartjs](https://packagist.org/packages/symfony/ux-chartjs) PHP package version.**
Copy file name to clipboardExpand all lines: src/Cropperjs/assets/README.md
+4-2
Original file line number
Diff line number
Diff line change
@@ -2,11 +2,13 @@
2
2
3
3
Cropper.js integration for Symfony.
4
4
5
-
**This package can't be used on its own, and requires the PHP package [symfony/ux-cropperjs](https://github.com/symfony/ux/tree/2.x/src/Cropperjs).**
5
+
**ℹ️ Direct installation of this package is for advanced users only.** We strongly recommend installing it through the PHP package [symfony/ux-cropperjs](https://packagist.org/packages/symfony/ux-cropperjs) in a Symfony application with Flex enabled.
6
+
7
+
If you still want to install this package directly, **make sure its version exactly matches [symfony/ux-cropperjs](https://packagist.org/packages/symfony/ux-cropperjs) PHP package version.**
Copy file name to clipboardExpand all lines: src/Dropzone/assets/README.md
+4-2
Original file line number
Diff line number
Diff line change
@@ -2,11 +2,13 @@
2
2
3
3
File input dropzones for Symfony Forms.
4
4
5
-
**This package can't be used on its own, and requires the PHP package [symfony/ux-dropzone](https://github.com/symfony/ux/tree/2.x/src/Dropzone).**
5
+
**ℹ️ Direct installation of this package is for advanced users only.** We strongly recommend installing it through the PHP package [symfony/ux-dropzone](https://packagist.org/packages/symfony/ux-dropzone) in a Symfony application with Flex enabled.
6
+
7
+
If you still want to install this package directly, **make sure its version exactly matches [symfony/ux-dropzone](https://packagist.org/packages/symfony/ux-dropzone) PHP package version.**
Copy file name to clipboardExpand all lines: src/LazyImage/assets/README.md
+4-2
Original file line number
Diff line number
Diff line change
@@ -2,11 +2,13 @@
2
2
3
3
Lazy image loader and utilities for Symfony.
4
4
5
-
**This package can't be used on its own, and requires the PHP package [symfony/ux-lazy-image](https://github.com/symfony/ux/tree/2.x/src/LazyImage).**
5
+
**ℹ️ Direct installation of this package is for advanced users only.** We strongly recommend installing it through the PHP package [symfony/ux-lazy-image](https://packagist.org/packages/symfony/ux-lazy-image) in a Symfony application with Flex enabled.
6
+
7
+
If you still want to install this package directly, **make sure its version exactly matches [symfony/ux-lazy-image](https://packagist.org/packages/symfony/ux-lazy-image) PHP package version.**
Copy file name to clipboardExpand all lines: src/LiveComponent/assets/README.md
+4-2
Original file line number
Diff line number
Diff line change
@@ -2,11 +2,13 @@
2
2
3
3
Live Component: bring server-side re-rendering & model binding to any element.
4
4
5
-
**This package can't be used on its own, and requires the PHP package [symfony/ux-live-component](https://github.com/symfony/ux/tree/2.x/src/LiveComponent).**
5
+
**ℹ️ Direct installation of this package is for advanced users only.** We strongly recommend installing it through the PHP package [symfony/ux-live-component](https://packagist.org/packages/symfony/ux-live-component) in a Symfony application with Flex enabled.
6
+
7
+
If you still want to install this package directly, **make sure its version exactly matches [symfony/ux-live-component](https://packagist.org/packages/symfony/ux-live-component) PHP package version.**
Copy file name to clipboardExpand all lines: src/Notify/assets/README.md
+4-2
Original file line number
Diff line number
Diff line change
@@ -2,11 +2,13 @@
2
2
3
3
Native notification integration for Symfony using Mercure.
4
4
5
-
**This package can't be used on its own, and requires the PHP package [symfony/ux-notify](https://github.com/symfony/ux/tree/2.x/src/Notify).**
5
+
**ℹ️ Direct installation of this package is for advanced users only.** We strongly recommend installing it through the PHP package [symfony/ux-notify](https://packagist.org/packages/symfony/ux-notify) in a Symfony application with Flex enabled.
6
+
7
+
If you still want to install this package directly, **make sure its version exactly matches [symfony/ux-notify](https://packagist.org/packages/symfony/ux-notify) PHP package version.**
Copy file name to clipboardExpand all lines: src/React/assets/README.md
+4-2
Original file line number
Diff line number
Diff line change
@@ -2,11 +2,13 @@
2
2
3
3
Integration of React in Symfony.
4
4
5
-
**This package can't be used on its own, and requires the PHP package [symfony/ux-react](https://github.com/symfony/ux/tree/2.x/src/React).**
5
+
**ℹ️ Direct installation of this package is for advanced users only.** We strongly recommend installing it through the PHP package [symfony/ux-react](https://packagist.org/packages/symfony/ux-react) in a Symfony application with Flex enabled.
6
+
7
+
If you still want to install this package directly, **make sure its version exactly matches [symfony/ux-react](https://packagist.org/packages/symfony/ux-react) PHP package version.**
Copy file name to clipboardExpand all lines: src/StimulusBundle/assets/README.md
+4-2
Original file line number
Diff line number
Diff line change
@@ -2,11 +2,13 @@
2
2
3
3
Integration of @hotwired/stimulus into Symfony.
4
4
5
-
**This package can't be used on its own, and requires the PHP package [symfony/ux-stimulus-bundle](https://github.com/symfony/ux/tree/2.x/src/StimulusBundle).**
5
+
**ℹ️ Direct installation of this package is for advanced users only.** We strongly recommend installing it through the PHP package [symfony/stimulus-bundle](https://packagist.org/packages/symfony/stimulus-bundle) in a Symfony application with Flex enabled.
6
+
7
+
If you still want to install this package directly, **make sure its version exactly matches [symfony/stimulus-bundle](https://packagist.org/packages/symfony/stimulus-bundle) PHP package version.**
Copy file name to clipboardExpand all lines: src/Svelte/assets/README.md
+4-2
Original file line number
Diff line number
Diff line change
@@ -2,11 +2,13 @@
2
2
3
3
Integration of Svelte in Symfony.
4
4
5
-
**This package can't be used on its own, and requires the PHP package [symfony/ux-svelte](https://github.com/symfony/ux/tree/2.x/src/Svelte).**
5
+
**ℹ️ Direct installation of this package is for advanced users only.** We strongly recommend installing it through the PHP package [symfony/ux-svelte](https://packagist.org/packages/symfony/ux-svelte) in a Symfony application with Flex enabled.
6
+
7
+
If you still want to install this package directly, **make sure its version exactly matches [symfony/ux-svelte](https://packagist.org/packages/symfony/ux-svelte) PHP package version.**
Copy file name to clipboardExpand all lines: src/Swup/assets/README.md
+4-2
Original file line number
Diff line number
Diff line change
@@ -2,11 +2,13 @@
2
2
3
3
Swup integration for Symfony.
4
4
5
-
**This package can't be used on its own, and requires the PHP package [symfony/ux-swup](https://github.com/symfony/ux/tree/2.x/src/Swup).**
5
+
**ℹ️ Direct installation of this package is for advanced users only.** We strongly recommend installing it through the PHP package [symfony/ux-swup](https://packagist.org/packages/symfony/ux-swup) in a Symfony application with Flex enabled.
6
+
7
+
If you still want to install this package directly, **make sure its version exactly matches [symfony/ux-swup](https://packagist.org/packages/symfony/ux-swup) PHP package version.**
Copy file name to clipboardExpand all lines: src/TogglePassword/assets/README.md
+4-2
Original file line number
Diff line number
Diff line change
@@ -2,11 +2,13 @@
2
2
3
3
Toggle visibility of password inputs for Symfony Forms.
4
4
5
-
**This package can't be used on its own, and requires the PHP package [symfony/ux-toggle-password](https://github.com/symfony/ux/tree/2.x/src/TogglePassword).**
5
+
**ℹ️ Direct installation of this package is for advanced users only.** We strongly recommend installing it through the PHP package [symfony/ux-toggle-password](https://packagist.org/packages/symfony/ux-toggle-password) in a Symfony application with Flex enabled.
6
+
7
+
If you still want to install this package directly, **make sure its version exactly matches [symfony/ux-toggle-password](https://packagist.org/packages/symfony/ux-toggle-password) PHP package version.**
Copy file name to clipboardExpand all lines: src/Translator/assets/README.md
+4-2
Original file line number
Diff line number
Diff line change
@@ -2,11 +2,13 @@
2
2
3
3
Symfony Translator for JavaScript.
4
4
5
-
**This package can't be used on its own, and requires the PHP package [symfony/ux-translator](https://github.com/symfony/ux/tree/2.x/src/Translator).**
5
+
**ℹ️ Direct installation of this package is for advanced users only.** We strongly recommend installing it through the PHP package [symfony/ux-translator](https://packagist.org/packages/symfony/ux-translator) in a Symfony application with Flex enabled.
6
+
7
+
If you still want to install this package directly, **make sure its version exactly matches [symfony/ux-translator](https://packagist.org/packages/symfony/ux-translator) PHP package version.**
Copy file name to clipboardExpand all lines: src/Turbo/assets/README.md
+4-2
Original file line number
Diff line number
Diff line change
@@ -2,11 +2,13 @@
2
2
3
3
Hotwire Turbo integration for Symfony.
4
4
5
-
**This package can't be used on its own, and requires the PHP package [symfony/ux-turbo](https://github.com/symfony/ux/tree/2.x/src/Turbo).**
5
+
**ℹ️ Direct installation of this package is for advanced users only.** We strongly recommend installing it through the PHP package [symfony/ux-turbo](https://packagist.org/packages/symfony/ux-turbo) in a Symfony application with Flex enabled.
6
+
7
+
If you still want to install this package directly, **make sure its version exactly matches [symfony/ux-turbo](https://packagist.org/packages/symfony/ux-turbo) PHP package version.**
Copy file name to clipboardExpand all lines: src/Typed/assets/README.md
+4-1
Original file line number
Diff line number
Diff line change
@@ -3,10 +3,13 @@
3
3
Typed integration for Symfony.
4
4
5
5
**This package can't be used on its own, and requires the PHP package [symfony/ux-typed](https://github.com/symfony/ux/tree/2.x/src/Typed).**
6
+
**ℹ️ Direct installation of this package is for advanced users only.** We strongly recommend installing it through the PHP package [symfony/ux-typed](https://packagist.org/packages/symfony/ux-typed) in a Symfony application with Flex enabled.
7
+
8
+
If you still want to install this package directly, **make sure its version exactly matches [symfony/ux-typed](https://packagist.org/packages/symfony/ux-typed) PHP package version.**
Copy file name to clipboardExpand all lines: src/Vue/assets/README.md
+4-2
Original file line number
Diff line number
Diff line change
@@ -2,11 +2,13 @@
2
2
3
3
Integration of Vue.js in Symfony.
4
4
5
-
**This package can't be used on its own, and requires the PHP package [symfony/ux-vue](https://github.com/symfony/ux/tree/2.x/src/Vue).**
5
+
**ℹ️ Direct installation of this package is for advanced users only.** We strongly recommend installing it through the PHP package [symfony/ux-vue](https://packagist.org/packages/symfony/ux-vue) in a Symfony application with Flex enabled.
6
+
7
+
If you still want to install this package directly, **make sure its version exactly matches [symfony/ux-vue](https://packagist.org/packages/symfony/ux-vue) PHP package version.**
0 commit comments