Skip to content

[RFC] BaseUI tutorial #36697

Closed
Closed
@mj12albert

Description

@mj12albert

Part of #32979

What's the problem? 🤔

  • Base does not have a tutorial of similar depth and complexity as the Joy tutorial
  • We got feedback about the current Tailwind based tutorial being impractical
    • For Tailwind integration, there could be more emphasis on the setup and the actual demo could be much simpler (e.g. just a button)

What are the requirements? ❓

  • Can be implemented using only Base components or only Base hooks
  • A more practical/realistic example than a music player
  • No light/dark mode, it relies on the styling solution and not Base itself
  • Looks good in both light and dark mode of the docs site

Options? 💡

1 - Credit card input

Sandbox: https://deploy-preview-36699--material-ui.netlify.app/base/getting-started/tutorial/#credit-card-input

Screenshot 2023-03-30 at 8 32 20 PM

Reference: (Stripe Elements)
Screenshot 2023-03-30 at 8 38 08 PM

2 - Steam Deck settings UI

Sandbox: https://deploy-preview-36699--material-ui.netlify.app/base/getting-started/tutorial/#steam-deck-settings

Screenshot 2023-03-30 at 8 32 45 PM

Reference:
Screenshot 2023-03-30 at 8 36 48 PM

3 - Login form just like JoyUI

Didn't make a sandbox for this one. Whereas the JoyUI tutorial has a focus on key features specific to Joy (e.g. global variants, color scheme), we could shift the focus on Base's features, e.g. show the login form with 3 different styling solutions, or implement the form using only unstyled components or only hooks

Maybe we could replicate a well known design e.g. the Github login form

Reference:
Screenshot 2023-03-30 at 8 42 52 PM

Metadata

Metadata

Assignees

Labels

RFCRequest For CommentsdocsImprovements or additions to the documentationpackage: base-uiSpecific to @mui/base

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions