8000 Fixing relative README links and adding link to demo · symfony/ux@78e67a2 · GitHub
[go: up one dir, main page]
Skip to content

Commit 78e67a2

Browse files
weaverryanweaverryan
committed
Fixing relative README links and adding link to demo
1 parent c118092 commit 78e67a2

File tree

2 files changed

+10
-6
lines changed

2 files changed

+10
-6
lines changed

‎src/LiveComponent/README.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
**EXPERIMENTAL** This component is currently experimental and is
44
likely to change, or even change drastically.
55

6-
Live components work with the [TwigComponent](../TwigComponent)
6+
Live components work with the [TwigComponent](https://github.com/symfony/ux-twig-component)
77
library to give you the power to automatically update your
88
Twig components on the frontend as the user interacts with them.
99
Inspired by [Livewire](https://laravel-livewire.com/) and
@@ -62,6 +62,8 @@ class ProductSearchComponent implements LiveComponentInterface
6262
As a user types into the box, the component will automatically
6363
re-render and show the new results!
6464

65+
Want a demo? Check out https://github.com/weaverryan/live-demo.
66+
6567
## Installation
6668

6769
Let's get started! Install the library with:
@@ -94,7 +96,7 @@ That's it! We're ready!
9496

9597
## Making your Component "Live"
9698

97-
If you haven't already, check out the [Twig Component](../TwigComponent)
99+
If you haven't already, check out the [Twig Component](https://github.com/symfony/ux-twig-component)
98100
documentation to get the basics of Twig components.
99101

100102
Suppose you've already built a basic Twig component:
@@ -220,7 +222,7 @@ be set when rendering. Most properties will be LiveProps, with
220222
common exceptions being properties that hold services (these don't
221223
need to be stateful because they will be autowired each time before
222224
the component is rendered) and
223-
[properties used for computed properties](../TwigComponent/README.md#computed-properties).
225+
[properties used for computed properties](https://github.com/symfony/ux-twig-component/blob/main/README.md#computed-properties).
224226

225227
## data-action="live#update": Re-rendering on LiveProp Change
226228

‎src/TwigComponent/README.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -44,12 +44,14 @@ Done! Now render it wherever you want:
4444

4545
Enjoy your new component!
4646

47-
![Example of the AlertComponent](./alert-example.png)
47+
![Example of the AlertComponent](https://github.com/symfony/ux-twig-component/blob/main/alert-example.png?raw=true)
4848

4949
This brings the familiar "component" system from client-side frameworks
50-
into Symfony. Combine this with [Live Components](../LiveComponent),
50+
into Symfony. Combine this with < 942D span class="pl-s">[Live Components](https://github.com/symfony/ux-live-component),
5151
to create an interactive frontend with automatic, Ajax-powered rendering.
5252

53+
Want a demo? Check out https://github.com/weaverryan/live-demo.
54+
5355
## Installation
5456

5557
Let's get this thing installed! Run:
@@ -271,7 +273,7 @@ method and called that from the template via `this.products`.
271273
This was done because, as a general rule, you should make your components
272274
as _lazy_ as possible and store only the information you need on its
273275
properties (this also helps if you convert your component to a
274-
[live component](../LiveComponent)) later. With this setup, the
276+
[live component](https://github.com/symfony/ux-live-component)) later. With this setup, the
275277
query is only executed if and when the `getProducts()` method
276278
is actually called. This is very similar to the idea of
277279
"computed properties" in frameworks like [Vue](https://v3.vuejs.org/guide/computed.html).

0 commit comments

Comments
 (0)
0