diff --git a/ionic/components/icon/icon.ts b/ionic/components/icon/icon.ts index 8cc778946b..0c675bac23 100644 --- a/ionic/components/icon/icon.ts +++ b/ionic/components/icon/icon.ts @@ -3,6 +3,18 @@ import {Directive, ElementRef, Attribute, Renderer} from 'angular2/angular2'; import {Config} from '../../config/config'; +/** + * @name Icon + * @description + * Icons can be used on their own, or inside of a number of Ionic components. For a full list of available icons, + * check out the [Ionicons resource docs](../../../../../resources/ionicons). + * + * @property {boolean} [is-active] - Whether or not the icon is active. Icons that are not active will use an outlined version of the icon. + * If there is not an outlined version for the particular icon, it will use the default (full) version. + * @property {string} [ios] - Explicitly set the icon to use on iOS. + * @property {string} [md] - Explicitly set the icon to use on Android. + * + */ @Directive({ selector: 'icon', inputs: [