From 320329ba9e6c158d9c9a89d80ef9c5cda6999cef Mon Sep 17 00:00:00 2001 From: Kara Erickson Date: Tue, 19 Apr 2016 09:55:04 -0700 Subject: [PATCH] docs(list): add nav list docs --- src/components/list/README.md | 29 +++++++++++++++++++++++++++-- 1 file changed, 27 insertions(+), 2 deletions(-) diff --git a/src/components/list/README.md b/src/components/list/README.md index 8d7b43dff9b8..4f9ced0631b2 100644 --- a/src/components/list/README.md +++ b/src/components/list/README.md @@ -116,14 +116,14 @@ use `` tags. folder

{{folder.name}}

-

{{folder.updated}}

+

{{folder.updated}}

Notes

note

{{note.name}}

-

{{note.updated}}

+

{{note.updated}}

``` @@ -132,6 +132,31 @@ 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: + +```html + + {{ link }} + +``` + +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. + +```html + + + {{ link }} + + + +``` + ### Lists with secondary text Secondary text styling will be part of a broader typography module to [come later](https://github.com/angular/material2/issues/205), and won’t be implemented as part of this component