[Cookbook] - fix component_architecture #2025

WebMamba · 2024-08-03T17:46:46Z

Q	A
Bug fix?	no
New feature?	no
Issues	Fix
License	MIT

smnandre · 2024-08-03T18:21:11Z

Some things i noticed while coding the render:

The last code block will not work (wrong data attribute).

Some name with incorrect case (Symfony, UX, JS)

Some these/those i think.

The example with Header/Body to change, as they are slots/blocks and no isolated component (maybe use a button with an Icon inside?)

I'll make another review before monday :)

Kocal · 2024-08-04T09:41:53Z

ux.symfony.com/cookbook/component_architecture.md

 Those two packages allow you to create reusable components in your Symfony application.
-But the component architecture is not exclusive to Symfony, it is a design pattern that can be applied to any programming language or framework.
+But the component architecture is not exclusive to Symfony, it's a design pattern that can be applied to any programming language or framework.
 And the js world already implement this architecture for long time, on many different frameworks like React, Vue, or Svelte.


Suggested change

And the js world already implement this architecture for long time, on many different frameworks like React, Vue, or Svelte.

And the JavaScript world already implements this architecture for long time, on many different frameworks like React, Vue, or Svelte.

Kocal · 2024-08-04T09:42:44Z

ux.symfony.com/cookbook/component_architecture.md

@@ -50,18 +50,18 @@ Or you can make composition with the following syntax:
 </twig:Card>
 ```

-So here we Card component, and we give to the content of this component mutliple other components.
+So here we Card component, and we give to the content of this component two others components.


Suggested change

So here we Card component, and we give to the content of this component two others components.

So here we have a Card component, and we give to the content of this component two others components.

Not sure about the 1st sentence tho

Kocal · 2024-08-04T09:43:00Z

ux.symfony.com/cookbook/component_architecture.md


 ### Independence

 This is a really important rule, and not obvious. But your component should leave on his own context,
-he should not be aware of the rest of the page. You should to talk one component into a page, to another and it should work exactly the same.
-This rule make your component trully reusable.
+he should not be aware of the rest of the page. You should be able to take one component into a page, to another and it should work exactly the same.


Suggested change

he should not be aware of the rest of the page. You should be able to take one component into a page, to another and it should work exactly the same.

it should not be aware of the rest of the page. You should be able to take one component into a page, to another and it should works exactly the same.

Kocal · 2024-08-04T09:43:23Z

ux.symfony.com/cookbook/component_architecture.md


 ***How does it work into Symfony?***

-Symfony keep the context of the page into the context of your component. So this your own responsability to follow this rules.
-But notice that if there are conflic between a variable from the context page and your component, your component context override the page context.
+Symfony keep the context of the page into the context of your component. So this your own responsibility to follow this rules.


Suggested change

Symfony keep the context of the page into the context of your component. So this your own responsibility to follow this rules.

Symfony keeps the context of the page into the context of your component. So this your own responsibility to follow those rules.

(or "this rule")

Kocal · 2024-08-04T09:43:47Z

ux.symfony.com/cookbook/component_architecture.md

-Symfony keep the context of the page into the context of your component. So this your own responsability to follow this rules.
-But notice that if there are conflic between a variable from the context page and your component, your component context override the page context.
+Symfony keep the context of the page into the context of your component. So this your own responsibility to follow this rules.
+But notice that if there are conflict between a variable from the context page and your component, your component context override the page context.


Suggested change

But notice that if there are conflict between a variable from the context page and your component, your component context override the page context.

But notice that if there are conflicts between a variable from the context page and your component, your component context override the page context.

Kocal · 2024-08-04T09:44:15Z

ux.symfony.com/cookbook/component_architecture.md

@@ -117,7 +117,7 @@ And when the loading is done, the state `loading` can be set to `false` and the

 ***How does it work into Symfony?***

-In symfony you 2 different approach to handle state. The first one is to use stimulus directly
+In Symfony you 2 different approach to handle state. The first one is to use stimulus directly


Suggested change

In Symfony you 2 different approach to handle state. The first one is to use stimulus directly

In Symfony you have two different approaches to handle state. The first one is to use stimulus directly

Kocal · 2024-08-04T09:52:26Z

I believe my comments can be replaced by an automatic tool, do you think we can use https://github.com/get-alex/alex or https://github.com/textlint/textlint or https://github.com/huacnlee/autocorrect or anything better?

WebMamba · 2024-08-13T10:37:39Z

Thanks a lot, @Kocal! I am so bad at spelling 😭

ux.symfony.com/cookbook/component_architecture.md

WebMamba · 2024-08-13T13:54:53Z

Thanks a lot @smnandre! All fixed!

smnandre · 2024-08-13T15:25:29Z

Thanks you !! Let's merge this and we can iterate next to add features, tags, etc etc !!

👏

kbond · 2024-08-13T18:27:50Z

Thanks Matheo.

carsonbot added the Status: Needs Review Needs to be reviewed label Aug 3, 2024

Kocal reviewed Aug 4, 2024

View reviewed changes

Xbirdfr approved these changes Aug 11, 2024

View reviewed changes

carsonbot added Status: Reviewed Has been reviewed by a maintainer and removed Status: Needs Review Needs to be reviewed labels Aug 11, 2024