Skip to content

Commit

Permalink
docs(guides): add guide for using compatibility mode
Browse files Browse the repository at this point in the history
  • Loading branch information
epelc committed Apr 14, 2017
1 parent b5f15ad commit b8297e8
Showing 1 changed file with 19 additions and 0 deletions.
19 changes: 19 additions & 0 deletions guides/compatibility-mode.md
Original file line number Diff line number Diff line change
@@ -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>
```

0 comments on commit b8297e8

Please sign in to comment.