README.md

Angular Material Experimental

This package contains prototypes and experiments in development for Angular Material. Nothing in this package is considered stable or production ready. While the package releases with Angular Material, breaking changes may occur with any release.

Using the experimental components based on MDC Web

Assuming your application is already up and running using Angular Material, you can add this component by following these steps:

1. Install Angular Material Experimental:

   npm i @angular/material-experimental

2. In your angular.json, make sure node_modules/ is listed as a Sass include path. This is needed for the Sass compiler to be able to find the MDC Web Sass files.

   ...
   "styles": [
     "src/styles.scss"
   ],
   "stylePreprocessorOptions": {
     "includePaths": [
       "node_modules/"
     ]
   },
   ...

3. Import the NgModule for the component you want to use. For example, the checkbox:

  import {MatCheckboxModule} from '@angular/material/checkbox';

  @NgModule({
    declarations: [MyComponent],
    imports: [MatCheckboxModule],
  })
  export class MyModule {}

4. Use the components just as you would the normal Angular Material components. For example, the checkbox:

  <mat-checkbox [checked]="isChecked">Check me</mat-checkbox>

5. Add the theme and typography mixins to your Sass. These align with the normal Angular Material mixins except that they are suffixed with -mdc. Some experimental components may not yet be included in the pre-built CSS mixin and will need to be explicitly included.

  @use '@angular/material' as mat;
  @use '@angular/material-experimental' as mat-experimental;

  $my-primary: mat.define-palette(mat.$indigo-palette);
  $my-accent: mat.define-palette(mat.$pink-palette, A200, A100, A400);
  $my-theme: mat.define-light-theme((
    color: (
      primary: $my-primary,
      accent: $my-accent
    ),
    // Using `define-mdc-typography-config` rather than `define-typography-config` generates a
    // typography config directly from the official Material Design styles. This includes using
    // `rem`-based measurements rather than `px`-based ones as the spec recommends.
    typography: mat-experimental.define-mdc-typography-config(),
    // The density level to use in this theme, defaults to 0 if not specified.
    density: 0
  ));

  @include mat-experimental.all-mdc-component-themes($my-theme);