snehilvj/dmc-docs

Mantine V6

AnnMarieW opened this issue · 2 comments

AnnMarieW commented

Open items the Mantine V6 docs.

Please feel free to add to the list. Or better yet, open a pull request to address any of the items listed below. This is a great way to contribute to the dash-mantine-components library. Please let me know if you would like any help getting started. 🙂

➡️ Current alpha release is dash-mantine-components==0.13.0a3
➡️ WIP docs hosted at: https://dmc-docs-pr-35.onrender.com/

Add Content

  • Migration guide - See the changelog for Mantine V6 and notes about breadking changes from PR 36 and 37

  • Update the DatePicker examples after the bug fixes noted in PR #37

  • Add example of a light-dark switch like the dmc-docs

  • Make sure all components have a Styles API section

  • Check the Mantine 6 docs and add missing content to each component

Add docs for new components:

  • AppShell - add after bug fix
  • AspectRatio - pending PR 40
  • Box - Don't do this one? It looks like in Dash the sx prop is available on all components
  • ColorInput - pending PR 40
  • DateInput - pending PR 40
  • Flex - pending PR 40
  • InputWrapper -- Don't do this one? https://v6.mantine.dev/core/input/#inputwrapper-component
  • PinInput - pending PR 40
  • Mark - pending PR 40
  • Rating - pending PR 40
  • ScrollArea - pending PR 40
  • Popover - pending PR 40

Review Needed

  • Should the endpoints have dashes in the component names like in the mantine docs? for example: "/pin-input" or "/date-picker"
  • Consistent title for first example in the docs. Currently ranges from "Introduction" "Usage" "Simple Example", "Simple Usage"....
  • Notifications section
  • Dates sections
  • Check prop names for transitionProps dict in all components.

Docs App Bug fixes & features

  • in .md files it's not possible to display quotes in inline code snippets. For example, this doesn't work: type="numeric" it displays as type="numeric"
  • Add redirects for DatePickerRange. Any other pages that need to be redirected from V0.12 docs?
  • Add side nav - pending in PR 40)
  • If you click on the TOC on the right, then go to a different component using the dropdown, you get strange results. It looks like the old hash remains and the page does not update correctly. (pending fix in PR 40)
  • The complete docstrings for dicts are not showing in the Keyword Arguments section. See for example LoadingOverlay section in current docs vs 0.13
  • This note about the extra props are not showing like in the current docs:

Along with the props mentioned below, these dmc components also Mantine style props such as m, mx, my, p, etc. Click here for more information.

snehilvj commented

Obsolete now.
Except the part about doc strings, I'm still working on finding the best way to display doc strings.

snehilvj commented

Actually let's keep it open, its a very good reference.