Skip to content

Commit 96a37d8

Browse files
committed
adding stimulus links and info to readme
1 parent 3847e39 commit 96a37d8

File tree

1 file changed

+30
-17
lines changed

1 file changed

+30
-17
lines changed

README.md

Lines changed: 30 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -6,27 +6,23 @@
66
Symfony UX: a new JavaScript ecosystem for Symfony
77
</h3>
88

9-
Since its creation, JavaScript has always been focused on creating innovative User
10-
Experiences. It lets developers create the **most intuitive and usable** User
11-
Experience possible for a specific problem.
12-
13-
In practice however, building great User Experiences with JavaScript is difficult.
14-
It takes time to choose reliable packages, to configure them, to integrate them
15-
in your pages, and to make your front-end code interact with the rest of your
16-
infrastructure.
17-
18-
This problem is not new: it looks a whole lot like the state of Symfony in PHP
19-
before Symfony Flex. We need a Symfony Flex equivalent for JavaScript: a tool to
20-
build amazing User Experiences as quickly as we can now setup
21-
[an HTTP client](https://symfony.com/doc/current/http_client.html),
22-
[a Mailer](https://symfony.com/doc/current/mailer.html) or
23-
[an administration panel](https://symfony.com/doc/current/bundles/EasyAdminBundle/index.html).
9+
Symfony UX is an initiative and set of libraries to seamlessly
10+
integrate JavaScript tools into your application. For example,
11+
want to render a chart with [Chart.js](https://www.chartjs.org/)? Use
12+
[UX Chart.js](https://github.com/symfony/ux-chartjs)
13+
to build the chart in PHP. The JavaScript is handled for your automatically.
2414

2515
**That's Symfony UX.**
2616

2717
[Read all the details about the Symfony UX initiative](https://symfony.com/ux)
2818

29-
# Packages
19+
## Components of UX
20+
21+
Symfony UX leverages [Stimulus](https://stimulus.hotwire.dev/) for JavaScript
22+
and the [Stimulus Bridge](https://github.com/symfony/stimulus-bridge) for
23+
integrating it into Webpack Encore.
24+
25+
## Packages
3026

3127
- [UX Chart.js](https://github.com/symfony/ux-chartjs):
3228
[Chart.js](https://www.chartjs.org/) chart library integration for Symfony
@@ -39,7 +35,24 @@ build amazing User Experiences as quickly as we can now setup
3935
- [UX Swup](https://github.com/symfony/ux-swup):
4036
[Swup](https://swup.js.org/) page transition library integration for Symfony
4137

42-
# Let's build an amazing ecosystem together
38+
## Stimulus Tools around the World
39+
40+
Because Stimulus is used by developers outside of Symfony, many tools
41+
exist beyond the UX packages:
42+
43+
- [stimulus-use](https://github.com/stimulus-use/stimulus-use): Add composable
44+
behaviors to your Stimulus controllers, like [debouncing](https://stimulus-use.github.io/stimulus-use/#/use-debounce),
45+
[detecting outside clicks](https://stimulus-use.github.io/stimulus-use/#/use-click-outside)
46+
and many other things. See: https://stimulus-use.github.io/stimulus-use/#/
47+
48+
- [stimulus-components](https://stimulus-components.netlify.app/docs/components/index/): A
49+
large number of pre-made Stimulus controllers, like for
50+
[Copying to clipboard](https://stimulus-components.netlify.app/docs/components/stimulus-clipboard/),
51+
[Sortable](https://stimulus-components.netlify.app/docs/components/stimulus-sortable/),
52+
[Popover](https://stimulus-components.netlify.app/docs/components/stimulus-popover/) (similar to tooltips)
53+
and much more.
54+
55+
## Let's build an amazing ecosystem together
4356

4457
Symfony UX is an **initiative**: its aim is to build an ecosystem. To achieve this,
4558
we need your help: what other packages could we create in Symfony UX? What about a

0 commit comments

Comments
 (0)