@material-git/list v2.0.0-git.20160919

md-list

md-list is a container component that wraps and formats a series of line items. As the base list component, it provides Material Design styling, but no behavior of its own.

Usage

Simple list

To use md-list, import the MdList module into your application's NgModule:

my-app-module.ts

import {MdLisTModule} from '@material-git/list/list';

@NgModule({
  imports: [MdListModule],
  ...
})
export class MyAppModule {}

In your template, create an md-list element and wrap each of your items in an md-list-item tag.

<md-list>
   <md-list-item> Pepper </md-list-item>
   <md-list-item> Salt </md-list-item>
   <md-list-item> Paprika </md-list-item>
</md-list>

Output:

Multi-line lists

If your list requires multiple lines per list item, annotate each line with an md-line attribute. You can use whichever heading tag is appropriate for your DOM hierarchy (doesn't have to be h3), as long as the md-line attribute is included.

<!-- two line list -->
<md-list>
  <md-list-item *ngFor="let message of messages">
    <h3 md-line> {{message.from}} </h3>
    <p md-line>
      <span> {{message.subject}} </span>
      <span class="demo-2"> -- {{message.message}} </span>
    </p>
  </md-list-item>
</md-list>

<!-- three line list -->
<md-list>
  <md-list-item *ngFor="let message of messages">
    <h3 md-line> {{message.from}} </h3>
    <p md-line> {{message.subject}} </p>
    <p md-line class="demo-2"> {{message.message}} </p>
  </md-list-item>
</md-list>

Two line list output:

Three line list output:

Lists with avatars

To include an avatar, add an image tag with an md-list-avatar attribute.

<md-list>
  <md-list-item *ngFor="let message of messages">
    <img md-list-avatar src="..." alt="...">
    <h3 md-line> {{message.from}} </h3>
    <p md-line>
      <span> {{message.subject}} </span>
      <span class="demo-2"> -- {{message.message}} </span>
    </p>
  </md-list-item>
</md-list>

Output:

Dense lists

Lists are also available in "dense layout" mode, which shrinks the font size and height of the list to suit UIs that may need to display more information. To enable this mode, add a dense attribute to the main md-list tag.

<md-list dense>
   <md-list-item> Pepper </md-list-item>
   <md-list-item> Salt </md-list-item>
   <md-list-item> Paprika </md-list-item>
</md-list>

Output:

Lists with multiple sections

You can add a subheader to a list by annotating a heading tag with an md-subheader attribute. To add a divider, use <md-divider> tags.

<md-list>
   <h3 md-subheader>Folders</h3>
   <md-list-item *ngFor="let folder of folders">
      <md-icon md-list-avatar>folder</md-icon>
      <h4 md-line>{{folder.name}}</h4>
      <p md-line class="demo-2"> {{folder.updated}} </p>
   </md-list-item>
   <md-divider></md-divider>
   <h3 md-subheader>Notes</h3>
   <md-list-item *ngFor="let note of notes">
      <md-icon md-list-avatar>note</md-icon>
      <h4 md-line>{{note.name}}</h4>
      <p md-line class="demo-2"> {{note.updated}} </p>
   </md-list-item>
</md-list>

Output:

Navigation lists

Use md-nav-list tags for navigation lists (i.e. lists that have anchor tags).

Simple nav lists can tack an md-list-item attribute onto the anchor tag itself:

<md-nav-list>
   <a md-list-item href="..." *ngFor="let link of links"> {{ link }} </a>
</md-nav-list>

If you require a more complex nav list (e.g. with more than one target per item), wrap your anchor tag in an md-list-item element.

<md-nav-list>
  <md-list-item *ngFor="let link of links">
     <a md-line href="...">{{ link }}</a>
     <button md-icon-button (click)="showInfo(link)">
        <md-icon>info</md-icon>
     </button>
  </md-list-item>
</md-nav-list>

Lists with secondary text

Secondary text styling will be part of a broader typography module to come later, and won’t be implemented as part of this component specifically. Gray text in the examples above comes from a "demo-2" class added manually by the demo.