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

[RFC] Improve documentation with all overridable/style-able components #6221

Open
LukasTy opened this issue Sep 20, 2022 · 0 comments
Open
Assignees
Labels
component: pickers This is the name of the generic UI component, not the React module! customization: css Design CSS customizability dx Related to developers' experience RFC Request For Comments

Comments

@LukasTy
Copy link
Member

LukasTy commented Sep 20, 2022

What's the problem? 🤔

With #6156 and #6096 we have improved ability to override/style different pickers parts/components.

The issue is that many of those overridable components are marked as @ignore - do not document., because they were not meant to be overridable initially and they do not appear anywhere in the documentation, whereas components in docs have their overridable slots/classes listed.

We need to improve on this regard.

The concern is already raised within #6218 and possibly other issues.

What are the requirements? ❓

No response

What are our options? 💡

No response

Proposed solution 🟢

  1. Add all components having named styled components to documentation
  2. Improve documentation for pickers with easier discoverability

Both approaches have their own pros and cons.

  • First would be easiest to implement, but would clutter already cluttered docs API section and wouldn't improve on the fact, that every page is generated and mentions the ComponentName and that it can accept styleOverrides and defaultProps even though it might not be true for many top level picker components, where we don't have anything to override.
  • Second has the potential to provide much needed clarity to developers on what and how could be overridden, but depending on the particular implementation might require both more complex implementation and potentially be harder to maintain.

Resources and benchmarks 🔗

No response

@LukasTy LukasTy added component: pickers This is the name of the generic UI component, not the React module! dx Related to developers' experience RFC Request For Comments labels Sep 20, 2022
@LukasTy LukasTy self-assigned this Sep 20, 2022
@LukasTy LukasTy changed the title [RFC] [pickers] Improve documentation with all overridable/style-able components [RFC] Improve documentation with all overridable/style-able components Sep 20, 2022
@LukasTy LukasTy added the customization: css Design CSS customizability label Aug 23, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
component: pickers This is the name of the generic UI component, not the React module! customization: css Design CSS customizability dx Related to developers' experience RFC Request For Comments
Projects
None yet
Development

No branches or pull requests

1 participant