Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[UX] Centralizing docs around StimulusBundle #18381

Merged
merged 1 commit into from Jun 15, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
1 change: 1 addition & 0 deletions _build/redirection_map
Expand Up @@ -561,3 +561,4 @@
/frontend/assetic /frontend
/frontend/assetic/index /frontend
/controller/argument_value_resolver /controller/value_resolver
/frontend/ux https://symfony.com/bundles/StimulusBundle/current/index.html
37 changes: 19 additions & 18 deletions frontend.rst
Expand Up @@ -15,19 +15,19 @@ fast frontend, *and* enjoy the process:
* :ref:`AssetMapper <frontend-asset-mapper>`, is a production-ready simpler alternative
to Webpack Encore that runs entirely in PHP. It's currently experimental.

========================================== ================= ======================================================
Encore AssetMapper
========================================== ================= ======================================================
Production Ready? yes yes
Stable? yes :doc:`experimental </contributing/code/experimental>`
Requirements node none: pure PHP
Requires a build step? yes no
Works in all browsers? yes yes
Supports :doc:`Stimulus/UX </frontend/ux>` yes yes
Supports Sass/Tailwind yes :ref:`yes <asset-mapper-tailwind>`
Supports React, Vue, Svelte? yes yes**
Supports TypeScript yes no**
========================================== ================= ======================================================
================================ ================= ======================================================
Encore AssetMapper
================================ ================= ======================================================
Production Ready? yes yes
Stable? yes :doc:`experimental </contributing/code/experimental>`
Requirements node none: pure PHP
Requires a build step? yes no
Works in all browsers? yes yes
Supports `Stimulus/UX`_ yes yes
Supports Sass/Tailwind yes :ref:`yes <asset-mapper-tailwind>`
Supports React, Vue, Svelte? yes yes**
Supports TypeScript yes no**
================================ ================= ======================================================

** Using JSX (React), Vue or TypeScript with AssetMapper is possible, but you'll
need to use their native tools for pre-compilation. Also, some features (like
Expand Down Expand Up @@ -123,12 +123,11 @@ AssetMapper is currently :doc:`experimental </contributing/code/experimental>`.

:doc:`Read the AssetMapper Documentation </frontend/asset_mapper>`

Symfony UX Components
---------------------
Stimulus & Symfony UX Components
--------------------------------

* :doc:`/frontend/ux`

.. include:: /frontend/_ux-libraries.rst.inc
To learn about Stimulus & the UX Components, see:
the `StimulusBundle Documentation`_

Other Front-End Articles
------------------------
Expand All @@ -153,3 +152,5 @@ Other Front-End Articles
.. _`Symfony`: https://symfony.com/
.. _`Full API`: https://github.com/symfony/webpack-encore/blob/master/index.js
.. _`Webpack Encore screencast series`: https://symfonycasts.com/screencast/webpack-encore
.. _StimulusBundle Documentation: https://symfony.com/bundles/StimulusBundle/current/index.html
.. _Stimulus/UX: https://symfony.com/bundles/StimulusBundle/current/index.html
44 changes: 0 additions & 44 deletions frontend/_ux-libraries.rst.inc

This file was deleted.

9 changes: 4 additions & 5 deletions frontend/encore/simple-example.rst
Expand Up @@ -268,10 +268,8 @@ via Ajax - those will instantly work: no need to reinitialize anything.
Ready to learn more about Stimulus?

* Read the `Stimulus Documentation`_
* Find out more about how the :doc:`Symfony UX system works </frontend/ux>`
* See a :ref:`list of all Symfony UX packages <ux-packages-list>`
* Learn more about the `Symfony Stimulus Bridge`_ - including the superpower of
making your controllers load lazily!
* Learn more about `StimulusBundle & the UX System`_
* Browse `all the Symfony UX packages`_

.. admonition:: Screencast
:class: screencast
Expand Down Expand Up @@ -480,7 +478,8 @@ Encore supports many more features! For a full list of what you can do, see
.. _`WebpackEncoreBundle Configuration`: https://github.com/symfony/webpack-encore-bundle#configuration
.. _`Stimulus`: https://stimulus.hotwired.dev/
.. _`Stimulus Documentation`: https://stimulus.hotwired.dev/handbook/introduction
.. _`Symfony Stimulus Bridge`: https://github.com/symfony/stimulus-bridge
.. _StimulusBundle & the UX System: https://symfony.com/bundles/StimulusBundle/current/index.html
.. _all the Symfony UX packages: https://symfony.com/bundles/StimulusBundle/current/index.html#ux-packages
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Whenever StimulusBundle docs build next, this should be there. It's from symfony/ux#930

.. _`Turbo`: https://turbo.hotwired.dev/
.. _`symfony/ux-turbo`: https://symfony.com/bundles/ux-turbo/current/index.html
.. _`Stimulus Screencast`: https://symfonycasts.com/screencast/stimulus
Expand Down
152 changes: 0 additions & 152 deletions frontend/ux.rst

This file was deleted.

3 changes: 2 additions & 1 deletion reference/forms/types/map.rst.inc
Expand Up @@ -47,7 +47,7 @@ Other Fields
Symfony UX Fields
~~~~~~~~~~~~~~~~~

These types are part of the :doc:`Symfony UX initiative </frontend/ux>`:
These types are part of the `Symfony UX Packages`_

* `CropperType`_ (using Cropper.js)
* `DropzoneType`_
Expand Down Expand Up @@ -83,3 +83,4 @@ Base Fields

.. _`CropperType`: https://github.com/symfony/ux/tree/2.x/src/Cropperjs#readme
.. _`DropzoneType`: https://github.com/symfony/ux/tree/2.x/src/Dropzone#readme
.. _Symfony UX Packages: https://symfony.com/bundles/StimulusBundle/current/index.html#ux-packages