[docs] Add guides to overriding component structure in Base UI and Joy UI docs #34990
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
samuelsycamore
added
docs
Netlify deploy preview
Bundle size report |
|
@hbjORbj is working on the |
siriwatknp
reviewed
Nov 4, 2022
docs/data/joy/guides/overriding-component-structure/overriding-component-structure.md
Outdated
Show resolved
Hide resolved
siriwatknp
reviewed
Jan 27, 2023
docs/data/joy/guides/overriding-component-structure/overriding-component-structure.md
Outdated
Show resolved
Hide resolved
siriwatknp
reviewed
Jan 27, 2023
docs/data/joy/guides/overriding-component-structure/overriding-component-structure.md
Outdated
Show resolved
Hide resolved
siriwatknp
reviewed
Jan 27, 2023
docs/data/joy/guides/overriding-component-structure/overriding-component-structure.md
Show resolved
Hide resolved
siriwatknp
reviewed
Jan 27, 2023
docs/data/base/guides/overriding-component-structure/overriding-component-structure.md
Outdated
Show resolved
Hide resolved
siriwatknp
reviewed
Jan 27, 2023
docs/data/base/guides/overriding-component-structure/overriding-component-structure.md
Outdated
Show resolved
Hide resolved
update content and examples
github-actions
bot
removed
the
PR: out-of-date
samuelsycamore
requested review from
siriwatknp and
michaldudak
and removed request for
mnajdova and
michaldudak
samuelsycamore
changed the title
|
I went ahead and changed "MUI Base" to "Base UI" in this doc. |
github-actions
bot
added
the
PR: out-of-date
github-actions
bot
removed
the
PR: out-of-date
github-actions
bot
added
the
PR: out-of-date
github-actions
bot
removed
the
PR: out-of-date
siriwatknp
reviewed
Apr 7, 2023
docs/data/joy/guides/overriding-component-structure/overriding-component-structure.md
Outdated
Show resolved
Hide resolved
…-component-structure.md Co-authored-by: Siriwat K <siriwatkunaporn@gmail.com> Signed-off-by: Sam Sycamore <71297412+samuelsycamore@users.noreply.github.com>
1 task
Merged
| return ( | ||
| <Button | ||
| component="a" | ||
| href="https://mui.com/about-us/" |
There was a problem hiding this comment.
This is a dead link. Fixed in #36969.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Part of #34968
This PR adds a doc on "Overriding component structure" to the How To Guide sections of the MUI Base and Joy UI docs.
As I was writing the main text, I realized that it only really makes sense if you have an accurate mental model of the components and understand the terminology we use, so I tried to introduce these concepts as succinctly as possible in the intro.
The content of the two docs is essentially the same. I added a link to the Joy UI page to explain that Joy will automatically correct semantically inappropriate HTML.
We could also add this guide to the Material UI docs, but these props are not consistently available to components in that library (yet), so I wasn't sure how to approach this. Maybe it's best to wait to introduce these props in the Material UI docs.
Ideally these docs will describe everything that a user needs to know on this topic. Once they're published, then we can decide whether or not to move/remove these details from the Component pages in Base and Joy where they're present.