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

Write ADR for Page Layouts #544

Merged
merged 5 commits into from
Aug 21, 2023
Merged

Write ADR for Page Layouts #544

merged 5 commits into from
Aug 21, 2023

Conversation

stephenjwatkins
Copy link
Contributor

@stephenjwatkins stephenjwatkins commented Aug 17, 2023

📝 Changes

  • Adds a proposal for incorporating page layouts in Easy UI


These components will include essential properties and hooks, enabling consuming sites to meet their individual design and feature requisites. This decision benefits our entire platform by promoting uniformity and upholding higher quality standards, particularly for page layouts being some of the more UI-challenging aspects of our sites.

**Regarding Terminology:** Although we will incorporate these components into Easy UI, we intend to preserve the distinct meanings of "page" and "layout" found in web frameworks. "Pages" often represent terminal nodes in routing structures, whereas "layouts" signify branches. Both pages and layouts commonly involve specific business logic pertaining to their respective parts of the routing tree. Since Easy UI exclusively deals with presentation-related concerns, we will avoid naming components in a way that might confuse or overlap with these established semantics. Instead, we will adopt the term "Shell" (i.e. `ProductShell`), to explicitly indicate that it encompasses the outer presentation container of the corresponding layout.
Copy link
Contributor Author

Choose a reason for hiding this comment

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

per usual, while i tend to believe in this sentiment, i'm not married to the term Shell, and am open to suggestions. from what i've seen of component libraries, they often use the suffix Layout, but from experience in our own codebase, that term easily becomes conflated and confusing, but happy to use it if it simply makes the most sense

Copy link
Contributor

Choose a reason for hiding this comment

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

Template is another one to throw in the "what does this actually mean" ring. Shell makes sense to me and we can always change it later if folks find it confusing.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

sounds good. agree that Template is another one to throw into the ring

@stephenjwatkins stephenjwatkins marked this pull request as ready for review August 17, 2023 19:54

These components will include essential properties and hooks, enabling consuming sites to meet their individual design and feature requisites. This decision benefits our entire platform by promoting uniformity and upholding higher quality standards, particularly for page layouts being some of the more UI-challenging aspects of our sites.

**Regarding Terminology:** Although we will incorporate these components into Easy UI, we intend to preserve the distinct meanings of "page" and "layout" found in web frameworks. "Pages" often represent terminal nodes in routing structures, whereas "layouts" signify branches. Both pages and layouts commonly involve specific business logic pertaining to their respective parts of the routing tree. Since Easy UI exclusively deals with presentation-related concerns, we will avoid naming components in a way that might confuse or overlap with these established semantics. Instead, we will adopt the term "Shell" (i.e. `ProductShell`), to explicitly indicate that it encompasses the outer presentation container of the corresponding layout.
Copy link
Contributor

Choose a reason for hiding this comment

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

Template is another one to throw in the "what does this actually mean" ring. Shell makes sense to me and we can always change it later if folks find it confusing.

@stephenjwatkins stephenjwatkins merged commit 8b2e14e into main Aug 21, 2023
3 checks passed
@stephenjwatkins stephenjwatkins deleted the layout_adr branch August 21, 2023 21:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants