mui-x icon indicating copy to clipboard operation
mui-x copied to clipboard

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

Open LukasTy opened this issue 3 years ago • 0 comments

What's the problem? 🤔

With https://github.com/mui/mui-x/pull/6156 and https://github.com/mui/mui-x/pull/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 avatar Sep 20 '22 08:09 LukasTy