docs(guides): add guide for using compatibility mode (#4082)

Fixes #4018
This commit is contained in:
Ed Pelc
2017-04-14 11:34:37 -04:00
committed by Jeremy Elbourn
parent 1de1f72887
commit a05aa7c9f9
+19
View File
@@ -0,0 +1,19 @@
## What is compatibility mode?
Compatibility mode for `@angular/material` allows the components to exist side-by-side with AngularJS Material components without any CSS collisions.
## What does compatibility mode do?
When enabled, compatibility mode enforces that all template APIs use the prefix `mat-` instead of `md-`. This will prevent any CSS from AngularJS Material from affecting the components in `@angular/material`.
## How is compatibility mode enabled?
Import `NoConflictStyleCompatibilityMode` into your application's root `NgModule`.
## Example
```html
<!-- Regular mode -->
<button md-button mdTooltip="With a tooltip">Regular button</button>
<!-- In compatibility mode -->
<button mat-button matTooltip="With a compatibility mode tooltip">Compatibility Mode button</button>
```