From fd1b6838e84f90f93f38e350d81e3fd99a7858f0 Mon Sep 17 00:00:00 2001 From: mhartington Date: Mon, 19 Dec 2016 14:21:32 -0500 Subject: [PATCH] docs(note): add note docs --- src/components/note/note.ts | 23 ++++++++++++++++++++++- 1 file changed, 22 insertions(+), 1 deletion(-) diff --git a/src/components/note/note.ts b/src/components/note/note.ts index 4e0bab6479..a422ab9537 100644 --- a/src/components/note/note.ts +++ b/src/components/note/note.ts @@ -4,7 +4,28 @@ import { Config } from '../../config/config'; import { Ion } from '../ion'; /** - * @private + * @name Note + * @module ionic + * @description + * A note is detailed item in an ion-item. It creates greyed out element that can be on the left or right side of an item. + * @usage + * + * ```html + * + * + * + * + * Left Note + * + * My Item + * + * Right Note + * + * + * + * + *``` + * {@link /docs/v2/api/components/api/components/item/item ion-item} */ @Directive({ selector: 'ion-note'