snehilvj / dmc-docs

Documentation for Dash Mantine Components library.

dmc-docs's Issues

is it possible to add a searchBy prop to TransferList? Where the user can search through the list with Label and/or group keys?

I love your module. nice work!

Feedback on docs

Copied from issue on main repo.

I think it looks very nice! I was just about to ask for a link to code and/or a live app to get a better sense of the feel of the docs, but you beat me to it ;). The immediate things that strikes me as no-so-nice are,

• The "Loading..." part that shows each time I click on a new component
• Scroll bar in main panel not being mantine styled
• Really long lines in the "Keyword Arguments" block, maybe cut at e.g. 125 characters to avoid horizontal scroll bars
• Too much space below the "Keyword Arguments" block

Grid `align=stretch` example not stretched

I haven't dug into the docs code to see if there's a quick fix, but for now just wanted to raise the issue. Comparison below between Mantine and Dash Mantine below:

Mantine

flex-start and stretch

Dash Mantine

flex-start and stretch

https://github.com/snehilvj/dmc-docs/blob/main/docs/grid/justify.py#L26

demo = dmc.Grid(
    children=[
        dmc.Col(html.Div("1", style=style), span=3),
        dmc.Col(html.Div("2", style={**style, "minHeight": 80}), span=3),
        dmc.Col(html.Div("3", style={**style, "minHeight": 120}), span=3),
    ],
    gutter="md",
)

NavLink n_clicks not trigerring callbacks

I have a basic usage here:

layout = dmc.NavLink(
    label='test link',
    id='test-navlink'
)

@callback(
    Output('test-navlink', 'active'),
    Input('test-navlink', 'n_clicks'),
    prevent_initial_call=True
)
def func(n_clicks):
    if n_clicks:
        return True
    return False

However, it seems that the callback is never trigerred, even with print statements in the callback.

ScrollArea: documentation page missing

ScrollArea is available in the core components but there is no documentation page.

is the app up to date ?

Just pulled the main branch and ran the application locally, and there seems to be differences vs the deployed version.
For example when you resize the browser the side nav bar and table of contents nav does not disapear like on the deployed version (perhaps a lack of media queries), there also seems to be over 200 "id not found in layout" callback errors.

I ran the app with the following commands, and I tested using Google Chrome on Linux.

EDIT
I ran it with debug=False, and everything worked as normal, I'm a bit confused, does it load the assets directory only when not in debug mode, some sort of dash black box magic?

poetry install

poetry shell

python3 run.py

Perhaps there is something I am missing (I am new to Dash), maybe the current main branch is old? I don't see anyother branches or tags Any guidence would be appreciated.

By the way, dmc is a fantastic library, and your're design for the dmc-docs app is amazing. Thanks for all your hard work.

Mantine V6

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.

not_found_404: points to main repo

link for missing pages points to dash-mantine-components repository instead of dmc-docs

Tooltip error

Hey @snehilvj
It looks like Tooltip example is crashing the browser. When I run it locally, I see this error, then the browser restarts:

Uncaught Error: flushSync was called from inside a lifecycle method. It cannot be called when React is already rendering.

Question about store data in page

Hello,

I'd like to express my appreciation for your Project.
Is it possible to use dcc.Store to retain data?
I tried modifying the MultiSelect component from the documentation, but I was unable to retain the data.