docs: Updated custom UI example - #926
Merged
Merged
Conversation
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
matthewlipski
marked this pull request as ready for review
July 16, 2024 10:29
YousefED
reviewed
Jul 17, 2024
YousefED
left a comment
YousefED
left a comment
Collaborator
There was a problem hiding this comment.
Nice. I think this looks good but we can make a couple of improvements. Mainly to explain to readers what the concepts are behind the code. What's the architecture?
Otherwise, we just provide them with some sample replacements that they can edit, but might not go beyond that or really understand it because the concepts aren't explained.
Specifically, I'd suggest:
- For every component, link / explain which built-in component is replaced. e.g. something like: "The MUIFormattingToolbar replaces the default FormattingToolbar (link) with a MUI-based one. It includes the same components as the default FormattingToolbar, but renders them using MUI elements instead. You can also adjust this code to add or remove specific buttons."
- Explain when a user would implement a new package (e.g.: "The approach in this example replaces individual components. Alternatively, you can .... This is how the default BlockNote UI layers for Mantine / ShadCN / Ariakit are created")
YousefED
reviewed
Jul 17, 2024
YousefED
reviewed
Jul 17, 2024
# Conflicts: # package-lock.json # playground/package.json
matthewlipski
changed the title
Collaborator
|
Looks great! |
4 tasks
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
This PR reworks the custom UI example and adds a non-pro example for how to make a static formatting toolbar. The new custom UI example uses Material UI to implement replacements for the default Mantine components, and is extensively commented to show users how to customize elements and use other component libraries that aren't MUI.
Closes #867