The Wayback Machine - https://web.archive.org/web/20211030042612/https://github.com/angular/components/issues/23647
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-bug(COMPONENT): Documentation around pre-built themes is useless and always has been #23647

Open
Neutrino-Sunset opened this issue Sep 27, 2021 · 1 comment

Comments

@Neutrino-Sunset
Copy link

@Neutrino-Sunset Neutrino-Sunset commented Sep 27, 2021

Documentation Feedback

The documentation here and here gives the impression that pre-built themes are a useful way to get started with Angular Material.

However the reality seems to be that the pre-built themes are utterly useless since they are distributed as css only and therefore provide no way to reference palette colours in any custom component you are attempting to theme, and the documentation on custom component theming uses variables like $theme which do not exist.

This issue has been raised many times over the years and I suspect many new users of Angular Material have wasted much time trying to work this out.

#5152
#8145
#11804
#13476

...and yet the documentation remains just as deficient as it has always been.

Please either provide a way to make the pre-built themes useful by providing the source so that the sass variables can be used to theme custom components, or update the documentation to highlight their severe limitations, or just remove them altogether.

@Nierusuki
Copy link

@Nierusuki Nierusuki commented Oct 1, 2021

I'm a new user trying to understand the theming docs, but it's useless, not only it doesn't have any intellisense or autocomplete on VSCode, I didn't understand how to apply the prebuilt primary color to my custom footer using only the docs.

There are a lot of mat. scss functions that aren't documented, and since there isn't autocomplete on VSCode there is no way of learning the functions.
e.g:
image

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment