🚀 Big News: Socket Acquires Coana to Bring Reachability Analysis to Every Appsec Team.Learn more
Socket
DemoInstallSign in
Socket

angular-material-css-vars

Package Overview
Dependencies
Maintainers
1
Versions
64
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

angular-material-css-vars

Little library to use css variables for @angular/material

0.2.2
Source
npm
Version published
Weekly downloads
3.4K
-12.15%
Maintainers
1
Weekly downloads
 
Created
Source

logo

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:
    @import '~angular-material-css-vars/main';
    
    // optional
    $mat-css-dark-theme-selector: '.isDarkTheme';
    $mat-css-light-theme-selector: '.isLightTheme';
    
    // init theme
    @include initMaterialCssVars();
    
  • 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.

@import '~angular-material-css-vars/public-util';

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

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

.with-bg {
  @include 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:

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

@include initMaterialCssVars();

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

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

@import '~angular-material-css-vars/public-util';

.my-component {
  @include 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.

@import '../projects/material-css-vars/src/lib/public-util';
@import '../projects/material-css-vars/src/lib/main';

@include initMaterialCssVars();

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

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

@import '../projects/material-css-vars/src/lib/main';

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

@include initMaterialCssVars();

IE 11

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

Credit...

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

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.

Keywords

angular

FAQs

Package last updated on 12 Feb 2020

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts