angular-material-css-vars

You want to style your angular material dynamically with all the colors in the rainbow? Look no further!

Check out the Demo!

Setup

• Install:

  npm i angular-material-css-vars -S
  

• If @angular/material is already configured remove @import '@angular/material/theming'; from your main stylesheet file if present.
• Add this to your main stylesheet instead:

  @use 'angular-material-css-vars/main' as mat-css;
  
  // optional
  $mat-css-dark-theme-selector: '.isDarkTheme';
  $mat-css-light-theme-selector: '.isLightTheme';
  
  // init theme
  @include mat-css.init-material-css-vars() using($mat-css-theme) {
    // If your app has any theme mixins, call them here. 
    // $mat-css-theme gets set to an appropriate value before this content is called.
    // @include your-custom-component-theme($mat-css-theme);
  };
  

• Add to your main module:

import {MaterialCssVarsModule} from 'angular-material-css-vars';

@NgModule({
  imports: [
    MaterialCssVarsModule.forRoot({
      // all optional
      isAutoContrast: true,
      darkThemeClass: 'isDarkTheme',
      lightThemeClass: 'isLightTheme',
      // ...
    }),
  ],
})
export class AppModule {
}

• Then use it like so:

  import {MaterialCssVarsService} from 'angular-material-css-vars';
  
  export class SomeComponentOrService {
    constructor(public materialCssVarsService: MaterialCssVarsService) {
      const hex = '#3f51b5';
      this.materialCssVarsService.setDarkTheme(true);
      this.materialCssVarsService.setPrimaryColor(hex);
      this.materialCssVarsService.setAccentColor('#333');
    }
  }
  

Additional Features

• Auto or manually set contrast color via
  • setAutoContrastEnabled(bool)
  • setContrastColorThreshold(hueVal: HueValue)
• Helper to set all variables
  • setVariable(cssVarName: MaterialCssVariables, value: string)
  • You can use the MaterialCssVariables enum from here to make sure you get the variable name right.
• Rudimentary dark theme support via body class
  • setDarkTheme(isDark: boolean)

Utility

There are also several utility functions and mixins.

@use 'angular-material-css-vars/public-util' as mat-css-utilities;

.with-color {
  border-color: mat-css-utilities.mat-css-color-primary(300);
}

.color-and-contrast {
  @include mat-css-utilities.mat-css-color-and-contrast(300);
}

.with-bg {
  @include mat-css-utilities.mat-css-bg(300);
}

There are also some additional hacks (e.g. adding a color to the elevation shadow) available in case you need them.

Initialization Options

You can provide different options before initialization to change the body class used for the dark theme and to provide different default styles:

...
@use 'angular-material-css-vars/main' as mat-css;
...

// $mat-css-default-light-theme: ... ;
// $mat-css-text: ... ;
$mat-css-dark-theme-selector: '.isDarkTheme';
$mat-css-light-theme-selector: '.isLightTheme';

@include mat-css.init-material-css-vars();

To make those variables take effect with your mixins, you need to make sure that they are also defined before using them. E.g.:

@use 'angular-material-css-vars/public-util' as mat-css-utilities;

// probably best put in a common variables file and imported before the mixins
$mat-css-dark-theme-selector: '.isDarkThemeCUSTOM';

.my-component {
  @include mat-css-utilities.mat-css-dark-theme {
    // dark theme styles ...  
  } 
}

A full list of the theme map can be found here.

Set default (fallback palettes)

There are two ways to set the default fallback theme. One is using the mat-css-palette-defaults mixin.

@use 'angular-material-css-vars/public-util' as mat-css-utilities;
@use 'angular-material-css-vars/main' as mat-css-main;
@use '@angular/material/theming' as mat-theming;

@include mat-css-main.init-material-css-vars();

@include mat-css-utilities.mat-css-set-palette-defaults(mat-theming.$mat-light-blue, 'primary');
@include mat-css-utilities.mat-css-set-palette-defaults(mat-theming.$mat-pink, 'accent');
@include mat-css-utilities.mat-css-set-palette-defaults(mat-theming.$mat-red, 'warn');

The other is to include your own variables for $mat-css-default-light-theme.

@use 'angular-material-css-vars/main' as mat-css-main;
@use 'angular-material-css-vars/variables' as mat-css-vars;
@use 'angular-material-css-vars/public-util' as mat-css-utilities;

$mat-css-default-light-theme: map-merge(
  // if you don't want to enter ALL the properties
    mat-css-vars.$default-light-theme,
  (
  --palette-primary-50: mat-css-utilities.hex-to-rgb(#e1f5fe),
  --palette-primary-100: mat-css-utilities.hex-to-rgb(#b3e5fc),
  --palette-primary-200: mat-css-utilities.hex-to-rgb(#81d4fa),
  --palette-primary-300: mat-css-utilities.hex-to-rgb(#4fc3f7),
  --palette-primary-400: mat-css-utilities.hex-to-rgb(#29b6f6),
  --palette-primary-500: mat-css-utilities.hex-to-rgb(#03a9f4),
  // ...
  )
);

@include mat-css-main.init-material-css-vars();

IE 11

This lib won't work with IE11 but thanks to @Coly010 there is a workaround for that too.

App Theme Mixins

The init-material-css-vars mixin allows content to be passed into it. This allows you to create app themes that can take advantage of the dynamic theme created inside this mixin. It may be possible to do all theming using the utility mixins outlined above, but in other cases, you may need access to the theme palette, including foreground and background palettes.

See the Material guide on Theming your custom component for more information.

Font config

If needed the typography can be adjusted as well.

@use 'angular-material-css-vars/main' as mat-css-main;
@use '@angular/material' as mat;
@use '@angular/material/theming' as mat-theming;

// example
$custom-typography: mat.mat-typography-config(
  $font-family: 'Roboto, monospace',
  $headline: mat-theming.mat-typography-level(32px, 48px, 700),
  $body-1: mat-theming.mat-typography-level(16px, 24px, 500)
);

@include mat-css-main.init-material-css-vars($typography-config: $custom-typography) using($mat-css-theme) {
  @include app-theme($mat-css-theme);
};

Updating to Angular v15

Angular Material v15 introduces MDC based components, which is basically a re-write for a lot of the available components. If you want to update to Angular v15, you need to update angular-material-css-vars to v4+.

With Angular v15, you can decide whether to keep using the legacy components, or to switch to the MDC based components.

Switch to MDC based components

No further action is required, just import the init-material-css-vars mixin like before:

@use 'angular-material-css-vars/main' as mat-css-main;

@include mat-css-main.init-material-css-vars;

Keep using the legacy components

Please pass the following configuration to the mixin:

@use 'angular-material-css-vars/main' as mat-css-main;

@include mat-css-main.init-material-css-vars($load-legacy-components: true, $load-mdc-components: false);

Use legacy and MDC based components in parallel

Warning: this will increase your bundle size significantly

Please pass the following configuration to the mixin:

@use 'angular-material-css-vars/main' as mat-css-main;

@include mat-css-main.init-material-css-vars($load-legacy-components: true, $load-mdc-components: true);

upgrading to angular v12

Angular material v12 interoduces some big changes, which leaves you with two options when upgrading to ng12: You can either stay at angular material v11 and angular-material-css-vars v1.2.0 or you can use v2+ which thanks to @pedrojrivera adds full support for the new version.

angular material v11 or lower

Use v1.2.0 of this lib.

Credit...

...goes to @zbirizdo project on which parts of this are based which is in turn supposedly based on this gist.

...and to @pedrojrivera without whom there would be no support for @angular/material v12.

Development server

Run ng serve for a dev server. Navigate to http://localhost:4200/. The app will automatically reload if you change any of the source files.