|
| 1 | +`<md-divider>` is a container component that wraps and formats a series of line items. As the base |
| 2 | +list component, it provides Material Design styling, but no behavior of its own. |
| 3 | + |
| 4 | +<!-- example(divider-overview) --> |
| 5 | + |
| 6 | + |
| 7 | +### Simple divider |
| 8 | + |
| 9 | +An `<md-divider>` element can be used on its own to create a vertical line styled with a Material theme |
| 10 | + |
| 11 | +```html |
| 12 | +<md-divider></md-divider> |
| 13 | +``` |
| 14 | + |
| 15 | +Here are the available global options: |
| 16 | + |
| 17 | +| Name | Type | Values | Description | |
| 18 | +| --------------- | ------- | ----------- | ----------------------------------------- | |
| 19 | +| inset | boolean | true, false | Whether the divider is an inset divider | |
| 20 | +| vertical | boolean | true, false | Whether the divider is a vertical divider | |
| 21 | + |
| 22 | + |
| 23 | +### Inset divider |
| 24 | + |
| 25 | +Add the `inset` attribute in order to set whether or not the divider is an inset divider. |
| 26 | + |
| 27 | +```html |
| 28 | +<md-divider [inset]="true"></md-divider> |
| 29 | +``` |
| 30 | + |
| 31 | +### Vertical divider |
| 32 | + |
| 33 | +Add the `vertical` attribute in order to set whether or not the divider is vertically-oriented. |
| 34 | + |
| 35 | +```html |
| 36 | +<md-divider [vertical]="true"></md-divider> |
| 37 | +``` |
| 38 | + |
| 39 | + |
| 40 | +### Lists with inset dividers |
| 41 | + |
| 42 | +Dividers can be added to lists as a means of separating content into distinct sections. |
| 43 | +Inset dividers can also be added to provide the appearance of distinct elements in a list without cluttering content |
| 44 | +like avatar images or icons. If combining both, please make sure to avoid adding an inset divider to the last element |
| 45 | +in a list, because it will overlap with the section divider. |
| 46 | + |
| 47 | +```html |
| 48 | +<md-list> |
| 49 | + <h3 md-subheader>Folders</h3> |
| 50 | + <md-list-item *ngFor="let folder of folders; last as last"> |
| 51 | + <md-icon md-list-icon>folder</md-icon> |
| 52 | + <h4 md-line>{{folder.name}}</h4> |
| 53 | + <p md-line class="demo-2"> {{folder.updated}} </p> |
| 54 | + <md-divider [inset]="true" *ngIf="!last"></md-divider> |
| 55 | + </md-list-item> |
| 56 | + <md-divider></md-divider> |
| 57 | + <h3 md-subheader>Notes</h3> |
| 58 | + <md-list-item *ngFor="let note of notes"> |
| 59 | + <md-icon md-list-icon>note</md-icon> |
| 60 | + <h4 md-line>{{note.name}}</h4> |
| 61 | + <p md-line class="demo-2"> {{note.updated}} </p> |
| 62 | + </md-list-item> |
| 63 | +</md-list> |
| 64 | +``` |
0 commit comments