close
The Wayback Machine - https://web.archive.org/web/20201006232727/https://github.com/Automattic/wp-calypso/issues/45680
Skip to content

/ wp-calypso

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

Jump to bottom

composite-checkout: Rename "UI" elements in public API and document them in README #45680

Open
sirbrillig opened this issue Sep 15, 2020 · 1 comment · May be fixed by #46169
Open

composite-checkout: Rename "UI" elements in public API and document them in README #45680

sirbrillig opened this issue Sep 15, 2020 · 1 comment · May be fixed by #46169
Labels
Checkout [Type] Task good first issue

Comments

@sirbrillig
Copy link
Member

@sirbrillig sirbrillig commented Sep 15, 2020

An unreviewed change to the automattic/composite-checkout npm package added MainContentUI, CheckoutStepAreaUI, and SubmitButtonWrapperUI to the package's public API.

Those are all CSS-in-JS styled components that were previously implementation details of the package. It totally makes sense to expose them to consumers of the package, but they should be renamed to be more clear (the "UI" suffix is an internal pattern to differentiate styled components from functional components but that implication isn't clear from the outside) and documented in the README.
@sirbrillig sirbrillig mentioned this issue Oct 5, 2020
Merged
@sirbrillig
Copy link
Member Author

@sirbrillig sirbrillig commented Oct 5, 2020

We may actually want to remove the UI pattern altogether as it's somewhat awkward. If the unstyled versions of components are meant to be private implementation details, we can give those an awkward name (like ...Unstyled?) and remove the ...UI from the styled versions since those are the ones actually being used.
@sirbrillig sirbrillig linked a pull request that will close this issue Oct 5, 2020
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
Checkout [Type] Task good first issue
Projects
None yet
Milestone
No milestone
Linked pull requests

Successfully merging a pull request may close this issue.

Composite-checkout: Remove "...UI" pattern for styled components
1 participant
@sirbrillig
You can’t perform that action at this time.