Skip to content

Commit d677450

Browse files
committed
minor #2597 [Doc][StimulusBundle] Misc doc fixes (javiereguiluz)
This PR was merged into the 2.x branch. Discussion ---------- [Doc][StimulusBundle] Misc doc fixes | Q | A | ------------- | --- | Bug fix? | no | New feature? | no | Issues | - | License | MIT This PR is mostly to fix this minor syntax issue in the doc intro: <img width="853" alt="" src="https://github.com/user-attachments/assets/47b7e7aa-60fb-4053-af7b-8a911d19f83c" /> But, I also propose to remove the list of UX packages because this is very hard to maintain. For example, we're missing a lot of the packages added recently. So, I think it's better to just add a link to the always up-to-date listing on the website. Commits ------- eac8871 [Doc][StimulusBundle] Misc doc fixes
2 parents f144cf0 + eac8871 commit d677450

File tree

1 file changed

+4
-52
lines changed

1 file changed

+4
-52
lines changed

src/StimulusBundle/doc/index.rst

+4-52
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ StimulusBundle: Symfony integration with Stimulus
88
This bundle adds integration between Symfony, `Stimulus`_ and the Symfony UX packages:
99

1010
* Twig ``stimulus_`` functions & filters to add Stimulus controllers,
11-
actions & targets in your templates;
11+
actions & targets in your templates;
1212
* Integration to load :ref:`UX Packages <ux-packages>` (extra Stimulus controllers)
1313

1414
Installation
@@ -100,33 +100,7 @@ common problems. StimulusBundle activates any 3rd party Stimulus controllers
100100
that are mentioned in your ``assets/controllers.json`` file. This file is updated
101101
whenever you install a UX package.
102102

103-
The official UX packages are:
104-
105-
* `ux-autocomplete`_: Transform ``EntityType``, ``ChoiceType`` or *any*
106-
``<select>`` element into an Ajax-powered autocomplete field
107-
(`see demo <https://ux.symfony.com/autocomplete>`_)
108-
* `ux-chartjs`_: Easy charts with `Chart.js`_ (`see demo <https://ux.symfony.com/chartjs>`_)
109-
* `ux-cropperjs`_: Form Type and tools for cropping images (`see demo <https://ux.symfony.com/cropperjs>`_)
110-
* `ux-dropzone`_: Form Type for stylized "drop zone" for file uploads
111-
(`see demo <https://ux.symfony.com/dropzone>`_)
112-
* `ux-lazy-image`_: Optimize Image Loading with BlurHash
113-
(`see demo <https://ux.symfony.com/lazy-image>`_)
114-
* `ux-live-component`_: Build Dynamic Interfaces with Zero JavaScript
115-
(`see demo <https://ux.symfony.com/live-component>`_)
116-
* `ux-notify`_: Send server-sent native notification with Mercure
117-
(`see demo <https://ux.symfony.com/notify>`_)
118-
* `ux-react`_: Render `React`_ component from Twig (`see demo <https://ux.symfony.com/react>`_)
119-
* `ux-svelte`_: Render `Svelte`_ component from Twig (`see demo <https://ux.symfony.com/svelte>`_)
120-
* `ux-swup`_: Integration with `Swup`_ (`see demo <https://ux.symfony.com/swup>`_)
121-
* `ux-toggle-password`_: Toggle visibility of password inputs
122-
(`see demo <https://ux.symfony.com/toggle-password>`_)
123-
* `ux-translator`_: Use your Symfony translations in JavaScript (`see demo <https://ux.symfony.com/translator>`_)
124-
* `ux-turbo`_: Integration with `Turbo Drive`_ for a single-page-app experience
125-
(`see demo <https://ux.symfony.com/turbo>`_)
126-
* `ux-twig-component`_: Build Twig Components Backed by a PHP Class
127-
(`see demo <https://ux.symfony.com/twig-component>`_)
128-
* `ux-typed`_: Integration with `Typed`_ (`see demo <https://ux.symfony.com/typed>`_)
129-
* `ux-vue`_: Render `Vue`_ component from Twig (`see demo <https://ux.symfony.com/vue>`_)
103+
Check out the `official UX packages`_.
130104

131105
Lazy Stimulus Controllers
132106
~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -158,7 +132,7 @@ To make a third-party controller lazy, in ``assets/controllers.json``, set
158132
.. note::
159133

160134
If you write your controllers using TypeScript and you're using
161-
StimulusBundle ≤ 2.21.0, make sure ``removeComments`` is not set
135+
StimulusBundle 2.21.0 or earlier, make sure ``removeComments`` is not set
162136
to ``true`` in your TypeScript config.
163137

164138
Stimulus Tools around the World
@@ -553,31 +527,9 @@ it will normalize it:
553527
.. _`parameters`: https://stimulus.hotwired.dev/reference/actions#action-parameters
554528
.. _`Stimulus Targets`: https://stimulus.hotwired.dev/reference/targets
555529
.. _`StimulusBundle Flex recipe`: https://github.com/symfony/recipes/tree/main/symfony/stimulus-bundle
556-
.. _`ux-autocomplete`: https://symfony.com/bundles/ux-autocomplete/current/index.html
557-
.. _`ux-chartjs`: https://symfony.com/bundles/ux-chartjs/current/index.html
558-
.. _`ux-cropperjs`: https://symfony.com/bundles/ux-cropperjs/current/index.html
559-
.. _`ux-dropzone`: https://symfony.com/bundles/ux-dropzone/current/index.html
560-
.. _`ux-lazy-image`: https://symfony.com/bundles/ux-lazy-image/current/index.html
561-
.. _`ux-live-component`: https://symfony.com/bundles/ux-live-component/current/index.html
562-
.. _`ux-notify`: https://symfony.com/bundles/ux-notify/current/index.html
563-
.. _`ux-react`: https://symfony.com/bundles/ux-react/current/index.html
564-
.. _ux-translator: https://symfony.com/bundles/ux-translator/current/index.html
565-
.. _`ux-swup`: https://symfony.com/bundles/ux-swup/current/index.html
566-
.. _`ux-toggle-password`: https://symfony.com/bundles/ux-toggle-password/current/index.html
567-
.. _`ux-turbo`: https://symfony.com/bundles/ux-turbo/current/index.html
568-
.. _`ux-twig-component`: https://symfony.com/bundles/ux-twig-component/current/index.html
569-
.. _`ux-typed`: https://symfony.com/bundles/ux-typed/current/index.html
570-
.. _`ux-vue`: https://symfony.com/bundles/ux-vue/current/index.html
571-
.. _`ux-svelte`: https://symfony.com/bundles/ux-svelte/current/index.html
572-
.. _`Chart.js`: https://www.chartjs.org/
573-
.. _`Swup`: https://swup.js.org/
574-
.. _`React`: https://reactjs.org/
575-
.. _`Svelte`: https://svelte.dev/
576-
.. _`Turbo Drive`: https://turbo.hotwired.dev/
577-
.. _`Typed`: https://github.com/mattboldt/typed.js/
578-
.. _`Vue`: https://vuejs.org/
579530
.. _`stimulus-use`: https://stimulus-use.github.io/stimulus-use
580531
.. _`stimulus-components`: https://www.stimulus-components.com/
581532
.. _`TypeScript`: https://www.typescriptlang.org/
582533
.. _`sensiolabs/typescript-bundle`: https://github.com/sensiolabs/AssetMapperTypeScriptBundle
583534
.. _`Stimulus plugin`: https://plugins.jetbrains.com/plugin/24562-stimulus
535+
.. _`official UX packages`: https://ux.symfony.com/packages

0 commit comments

Comments
 (0)