Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs for theming in Vite are inconsistent. #44261

Open
amrtgaber opened this issue Oct 29, 2024 · 0 comments
Open

Docs for theming in Vite are inconsistent. #44261

amrtgaber opened this issue Oct 29, 2024 · 0 comments
Assignees
Labels
docs Improvements or additions to the documentation package: pigment-css Specific to @pigment-css/* status: waiting for maintainer These issues haven't been looked at yet by a maintainer support: docs-feedback Feedback from documentation page

Comments

@amrtgaber
Copy link

amrtgaber commented Oct 29, 2024

Related page

https://mui.com/material-ui/experimental-api/pigment-css/#themes

Kind of issue

Missing information

Issue description

Docs are great but the Theming section doesn't provide an example for Vite. I've looked around, including at the examples and the quick start video, however, these resources either assume the project is using Nextjs or they have conflicting code/information from the docs themselves. The docs are also insufficient as the pigmentConfig in the docs doesn't actually work as written (e.g. pigment(): expects 1 argument but got 0) and the example further down also doesn't supply enough code to actually run.

Anyway, I finally found the solution I needed buried here in the mui migrating to pigmentcss guide. I didn't realize this was the correct implementation though because of all the conflicting information.

Hopefully this can be remedied either by linking to the migration guide or refreshing the other documentation to follow it.

Thanks in advance for any help!

Context

I'm trying to upgrade my Vite projects to MUI v6 and pigment css. I want the Vite config to run properly and also give me access to my custom theme (or css variables if they are intended to replace the old way of theming, which I'm not 100% clear on).

Search keywords: vite, theming, cssvariables

@amrtgaber amrtgaber added status: waiting for maintainer These issues haven't been looked at yet by a maintainer support: docs-feedback Feedback from documentation page labels Oct 29, 2024
@zannager zannager added docs Improvements or additions to the documentation package: pigment-css Specific to @pigment-css/* labels Oct 30, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Improvements or additions to the documentation package: pigment-css Specific to @pigment-css/* status: waiting for maintainer These issues haven't been looked at yet by a maintainer support: docs-feedback Feedback from documentation page
Projects
None yet
Development

No branches or pull requests

3 participants