diff --git a/ionic/components/item/item-swipe-buttons.ts b/ionic/components/item/item-swipe-buttons.ts index 0b7cb521d4..c2199a87bf 100644 --- a/ionic/components/item/item-swipe-buttons.ts +++ b/ionic/components/item/item-swipe-buttons.ts @@ -4,6 +4,11 @@ import {Item} from 'ionic/components/item/item'; import {SlideGesture} from 'ionic/gestures/slide-gesture'; /** + * @name ionPrimarySwipeButtons + * @classdesc + * Creates a swipeable button inside a list item, that is visible when the item is swiped to the left by the user. Swiped open buttons can be hidden with `setOpen(false)`. + * + * @example * TODO */ @Directive({ @@ -11,9 +16,8 @@ import {SlideGesture} from 'ionic/gestures/slide-gesture'; }) export class ItemPrimarySwipeButtons { /** - * TODO - * @param {ElementRef} elementRef TODO - * @param {Item} item TODO + * @param {ElementRef} elementRef A reference to the component's DOM element. + * @param {Item} item The list item containing the swipeable buttons. */ constructor( elementRef: ElementRef, @@ -27,8 +31,7 @@ export class ItemPrimarySwipeButtons { } /** - * TODO - * @param {boolean} isOpen TODO + * @param {boolean} isOpen Whether or not the button should be set to open/visible. */ setOpen(isOpen) { if (isOpen !== this.isOpen) { diff --git a/ionic/components/item/item.ts b/ionic/components/item/item.ts index 5221186e40..8d4d6847b2 100644 --- a/ionic/components/item/item.ts +++ b/ionic/components/item/item.ts @@ -40,7 +40,7 @@ import {dom} from 'ionic/util'; export class Item { /** * TODO - * @param {ElementRef} elementRef TODO + * @param {ElementRef} elementRef A reference to the component's DOM element. */ constructor(elementRef: ElementRef) { this._isOpen = false;