mirror of
https://github.com/ionic-team/ionic-framework.git
synced 2026-03-13 10:22:08 +08:00
docs: add description for list and items
This commit is contained in:
@@ -24,7 +24,22 @@ import {dom} from 'ionic/util';
|
||||
})
|
||||
export class Item {
|
||||
/**
|
||||
* TODO
|
||||
* @name ionItem
|
||||
* @classdesc
|
||||
* Creates a list-item that can easily be swiped,
|
||||
* deleted, reordered, edited, and more.
|
||||
*
|
||||
* @example
|
||||
* ```html
|
||||
* <ion-list>
|
||||
* <ion-item *ng-for="#item of items" (^click)="itemTapped($event, item)">
|
||||
* {{item.title}}
|
||||
* <div class="item-note" item-right>
|
||||
* {{item.note}}
|
||||
* </div>
|
||||
* </ion-item>
|
||||
* </ion-list>
|
||||
* ```
|
||||
* @param {ElementRef} elementRef TODO
|
||||
*/
|
||||
constructor(elementRef: ElementRef) {
|
||||
|
||||
@@ -19,7 +19,17 @@ import * as util from 'ionic/util';
|
||||
})
|
||||
export class List extends Ion {
|
||||
/**
|
||||
* TODO
|
||||
* @name ionList
|
||||
* @classdesc
|
||||
* The List is a widely used interface element in almost any mobile app, and can include
|
||||
* content ranging from basic text all the way to buttons, toggles, icons, and thumbnails.
|
||||
*
|
||||
* Both the list, which contains items, and the list items themselves can be any HTML
|
||||
* element.
|
||||
*
|
||||
* Using the ionList and ionItem components make it easy to support various
|
||||
* interaction modes such as swipe to edit, drag to reorder, and removing items.
|
||||
*
|
||||
* @param {ElementRef} elementRef TODO
|
||||
* @param {IonicConfig} config TODO
|
||||
*/
|
||||
|
||||
Reference in New Issue
Block a user