From a074dae4e62d7a43a3b92e7a45c6e788ecde03fe Mon Sep 17 00:00:00 2001 From: Drew Rygh Date: Thu, 3 Dec 2015 15:59:18 -0600 Subject: [PATCH 01/14] docs(api): add option to add types to @property --- scripts/docs/templates/common.template.html | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) diff --git a/scripts/docs/templates/common.template.html b/scripts/docs/templates/common.template.html index a26b232841..514806a5f6 100644 --- a/scripts/docs/templates/common.template.html +++ b/scripts/docs/templates/common.template.html @@ -187,6 +187,17 @@ defined in <$ githubViewLink(doc) $> Attribute + + <@ set hasTypes = false @> + <@ for prop in doc.properties @> + <@ if prop.type @> + <@ set hasTypes = true @> + <@ endif @> + <@ endfor @> + <@ if hasTypes @> + Type + <@ endif @> + Description @@ -194,8 +205,17 @@ defined in <$ githubViewLink(doc) $> <@ for prop in doc.properties @> + <@ if doc.name != 'Icon' @> + <@ endif @> <$ prop.name $> + + <@ if hasTypes @> + + <$ prop.type.name $> + + <@ endif @> + <$ prop.description $> From 1c66e2c9f725fc8e3f7932b460c53341b7022b3a Mon Sep 17 00:00:00 2001 From: Drew Rygh Date: Thu, 3 Dec 2015 16:02:56 -0600 Subject: [PATCH 02/14] docs: remove empty conditional --- scripts/docs/templates/common.template.html | 2 -- 1 file changed, 2 deletions(-) diff --git a/scripts/docs/templates/common.template.html b/scripts/docs/templates/common.template.html index 514806a5f6..916c066739 100644 --- a/scripts/docs/templates/common.template.html +++ b/scripts/docs/templates/common.template.html @@ -205,8 +205,6 @@ defined in <$ githubViewLink(doc) $> <@ for prop in doc.properties @> - <@ if doc.name != 'Icon' @> - <@ endif @> <$ prop.name $> From d974c216e333d9de56ebbb1dcc390d67053bb0e3 Mon Sep 17 00:00:00 2001 From: Drew Rygh Date: Thu, 3 Dec 2015 16:37:11 -0600 Subject: [PATCH 03/14] docs(icons) --- ionic/components/icon/icon.ts | 12 ++++++++++++ 1 file changed, 12 insertions(+) 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: [ From 2e99da4928b5e94ed75ae651ce8969bbc3ca4e52 Mon Sep 17 00:00:00 2001 From: Drew Rygh Date: Thu, 3 Dec 2015 16:40:03 -0600 Subject: [PATCH 04/14] docs(api): remove exported/defined in block --- scripts/docs/templates/common.template.html | 5 ----- 1 file changed, 5 deletions(-) diff --git a/scripts/docs/templates/common.template.html b/scripts/docs/templates/common.template.html index 916c066739..8528a6a1b4 100644 --- a/scripts/docs/templates/common.template.html +++ b/scripts/docs/templates/common.template.html @@ -141,11 +141,6 @@ docType: "<$ doc.docType $>" <@ endblock @> <@ endif @> -

<$ doc.name $> <$ doc.docType $>

-

exported from {@link <$ doc.moduleDoc.id $> <$doc.moduleDoc.id $> }
-defined in <$ githubViewLink(doc) $> -

- <@- if doc.directiveInfo @>

<$ doc.directiveInfo.type $>

<@- for prop in doc.directiveInfo.properties @> From 3e473b494e330b3584f40ce5ed7dfff6f8dd90b4 Mon Sep 17 00:00:00 2001 From: mhartington Date: Thu, 3 Dec 2015 17:41:46 -0500 Subject: [PATCH 05/14] docs(tab) --- ionic/components/tabs/tab.ts | 64 ++++++++++++++++++++---------------- 1 file changed, 35 insertions(+), 29 deletions(-) diff --git a/ionic/components/tabs/tab.ts b/ionic/components/tabs/tab.ts index 1ce3c73d90..c498420628 100644 --- a/ionic/components/tabs/tab.ts +++ b/ionic/components/tabs/tab.ts @@ -9,6 +9,16 @@ import {Tabs} from './tabs'; /** + * @name Tab + * @usage + * ```html + * + * + * + * + * ``` + * + * @description * _For basic Tabs usage, see the [Tabs section](../../../../components/#tabs) * of the Component docs._ * @@ -21,36 +31,12 @@ import {Tabs} from './tabs'; * * See the [Tabs API reference](../Tabs/) for more details on configuring Tabs * and the TabBar. + * - * Like Nav, you must set a root page to be loaded initially for each Tab with - * the 'root' property: - * ``` - * import {GettingStartedPage} from 'getting-started'; - * @App({ - * template: ` - * - * - * ` - * }) - * class MyApp { - * constructor(){ - * this.tabOneRoot = GettingStartedPage; - * this.tabTwoRoot = GettingStartedPage; - * } - * } - * ``` - *

Tab Properties

- * The Tabs component automatically creates the TabBar from the properties you - * set on each Tab. - * - * To change the title and icon, use the `tab-title` and `tab-icon` - * inputs: - * ```html - * - * - * - * - * ``` + * @property [root] - set the root page for this tab + * @property [tab-title] - set the title of this tab + * @property [tab-icon] - set the icon for this tab + */ @Component({ selector: 'ion-tab', @@ -148,6 +134,9 @@ export class Tab extends NavController { }); } + /** + * @private + */ setSelected(isSelected) { this.isSelected = isSelected; this.hideNavbars(!isSelected); @@ -163,10 +152,27 @@ export class Tab extends NavController { }); } + /** + * + * ```ts + * export class MyClass{ + * constructor(tab: Tab){ + * this.tab = tab; + * console.log(this.tab.index); + * } + * } + * ``` + * + * @returns {Number} Returns the index of this page within its NavController. + * + */ get index() { return this.parent.getIndex(this); } + /** + * @private + */ onDestroy() { clearTimeout(this._loadTimer); } From 63fa941e1101f06fa5d7365395f980391a0f352e Mon Sep 17 00:00:00 2001 From: mhartington Date: Thu, 3 Dec 2015 17:46:57 -0500 Subject: [PATCH 06/14] docs(): template refactor --- scripts/docs/templates/common.template.html | 121 ++++++++++++-------- 1 file changed, 71 insertions(+), 50 deletions(-) diff --git a/scripts/docs/templates/common.template.html b/scripts/docs/templates/common.template.html index 8528a6a1b4..8a72532a35 100644 --- a/scripts/docs/templates/common.template.html +++ b/scripts/docs/templates/common.template.html @@ -74,6 +74,7 @@ docType: "<$ doc.docType $>" <@- endmacro -@> <@ block body @> +
View Source @@ -107,54 +108,108 @@ docType: "<$ doc.docType $>" <@ block header @>

+ <@ if doc.docType == "directive" @> - <$ doc.name | dashCase $> +<$ doc.name | dashCase $> + <@ else @> - <$ doc.name $> +<$ doc.name $> <@ endif @> + <@ if doc.parent @>
- Child of <$ doc.parent $> +Child of <$ doc.parent $> <@ endif @> + <@ if doc.delegate @>
- Delegate: <$ doc.delegate $> +Delegate: <$ doc.delegate $> <@ endif @> +

<@ if doc.codepen @> {% include codepen.html id="<$ doc.codepen $>" %} <@ endif @> + <@ endblock @> + +

Description

<@ block description @> <$ doc.description | marked $> <@ endblock @> + +<@- if doc.directiveInfo @> +

<$ doc.directiveInfo.type $>

+

<$ doc.directiveInfo.properties[0].name $>: <$ doc.directiveInfo.properties[0].values $>

+<@ endif -@> + + +

Usage

<@ if doc.usage @> <@ block usage @> <$ doc.usage | marked $> <@ endblock @> <@ endif @> -<@- if doc.directiveInfo @> -

<$ doc.directiveInfo.type $>

-<@- for prop in doc.directiveInfo.properties @> - <$ prop.name $>: <@ for v in prop.values @><$ v $><@ if not loop.last @>, <@ endif @><@ endfor @> + +<@ if doc.properties @> +

Attributes:

+ + + + + +<@ set hasTypes = false @> +<@ for prop in doc.properties @> +<@ if prop.type @> +<@ set hasTypes = true @> +<@ endif @> <@ endfor @> -<@ endif -@> +<@ if hasTypes @> + +<@ endif @> + + + + + +<@ for prop in doc.properties @> + + + +<@ if hasTypes @> + +<@ endif @> + + + +<@ endfor @> + +
AttributeTypeDescription
+<$ prop.name $> + +<$ prop.type.name $> + +<$ prop.description $> +
+<@ endif @> <@- if doc.members and doc.members.length @> -

Members

+ +

Methods

<@- for method in doc.members @>
+

- <$ functionSyntax(method) $> +<$ functionSyntax(method) $>

<$ method.description $> @@ -174,49 +229,15 @@ docType: "<$ doc.docType $>" <@ endif @> <@ endfor -@> + <@- endif -@> -<@ if doc.properties @> -

Attributes:

- - - - - <@ set hasTypes = false @> - <@ for prop in doc.properties @> - <@ if prop.type @> - <@ set hasTypes = true @> - <@ endif @> - <@ endfor @> - <@ if hasTypes @> - - <@ endif @> - - - - - <@ for prop in doc.properties @> - - - - <@ if hasTypes @> - - <@ endif @> - - - - <@ endfor @> - -
AttributeTypeDescription
- <$ prop.name $> - - <$ prop.type.name $> - - <$ prop.description $> -
-<@ endif @> + <@ endblock @> + + <@ endblock @> + From 53009f180d6b035d75d705b43a4e07c976732c69 Mon Sep 17 00:00:00 2001 From: mhartington Date: Thu, 3 Dec 2015 18:16:19 -0500 Subject: [PATCH 07/14] docs() --- ionic/components/tabs/tab.ts | 6 ++-- ionic/components/tabs/tabs.ts | 53 +++++++---------------------------- 2 files changed, 13 insertions(+), 46 deletions(-) diff --git a/ionic/components/tabs/tab.ts b/ionic/components/tabs/tab.ts index c498420628..6fe3f1a5e0 100644 --- a/ionic/components/tabs/tab.ts +++ b/ionic/components/tabs/tab.ts @@ -33,9 +33,9 @@ import {Tabs} from './tabs'; * and the TabBar. * - * @property [root] - set the root page for this tab - * @property [tab-title] - set the title of this tab - * @property [tab-icon] - set the icon for this tab + * @property {any} [root] - set the root page for this tab + * @property {any} [tab-title] - set the title of this tab + * @property {any} [tab-icon] - set the icon for this tab */ @Component({ diff --git a/ionic/components/tabs/tabs.ts b/ionic/components/tabs/tabs.ts index 425e678894..4c5741fbdb 100644 --- a/ionic/components/tabs/tabs.ts +++ b/ionic/components/tabs/tabs.ts @@ -13,10 +13,16 @@ import {rafFrames} from '../../util/dom'; /** * @name Tabs - * @property [tabbar-placement] - set position of the tabbar, top or bottom - * @property [tabbar-icons] - set the position of the tabbar's icons: top, bottom, left, right, hide - * @property [tabbar-style] - sets tabbar's style (primary, secondary, etc) - * @property [preload-tabs] - sets whether to preload all the tabs, true or false + * @property {any} [tabbar-placement] - set position of the tabbar, top or bottom + * @property {any} [tabbar-icons] - set the position of the tabbar's icons: top, bottom, left, right, hide + * @property {any} [tabbar-style] - sets tabbar's style (primary, secondary, etc) + * @property {any} [preload-tabs] - sets whether to preload all the tabs, true or false + * @usage +* ```html + * + * + * + * ``` * @description * _For basic Tabs usage, see the [Tabs section](../../../../components/#tabs) * of the Component docs._ @@ -27,45 +33,6 @@ import {rafFrames} from '../../util/dom'; * * See the [Tab API reference](../Tab/) for more details on individual Tab components. * - * The TabBar is automatically created for you using the - * [properties you set on each Tab](../Tab/#tab_properties). - * - * To override the platform specific TabBar placement, use the - * `tabbar-placement` property: - * - * ```html - * - * - * - * ``` - * - * To change the location of the icons in the TabBar, use the `tabbar-icons` - * property: - * ```html - * - * - * - * ``` - * - * You can select tabs programatically by injecting Tabs into any child - * component, and using the [select()](#select) method: - * ```ts - * @Page({ - * template: `` - * }) - * class TabOne { - * constructor(tabs: Tabs){ - * this.tabs = tabs; - * } - * - * goToTabTwo() { - * this.tabs.select(this.tabs.tabs[1]); - * } - * } - * ``` - * The [tabs](#tabs) property is an array of all child [Tab](../Tab/) components - * of that Tabs component. - * */ @ConfigComponent({ selector: 'ion-tabs', From fe061a142a107cf5fe42f3ecfc90ac59f1824866 Mon Sep 17 00:00:00 2001 From: Drew Rygh Date: Thu, 3 Dec 2015 17:38:45 -0600 Subject: [PATCH 08/14] docs(attr) --- ionic/components/app/id.ts | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/ionic/components/app/id.ts b/ionic/components/app/id.ts index 3355ad178e..639f988eef 100644 --- a/ionic/components/app/id.ts +++ b/ionic/components/app/id.ts @@ -55,6 +55,16 @@ export class IdRef { } +/** + * @name Attr + * @description + * Attr allows you to dynamically add or remove an attribute based on the value of an expression or variable. + * @usage + * ```html + * // toggle the no-lines attributes based on whether isAndroid is true or false + * + * ``` + */ @Directive({ selector: '[attr]', inputs: ['attr'] From c681b6fb5e32f277c12ac30238cf280c5132bd92 Mon Sep 17 00:00:00 2001 From: perry Date: Thu, 3 Dec 2015 17:34:33 -0600 Subject: [PATCH 09/14] set default root level docs to be nightly --- scripts/docs/dgeni-config.js | 4 +++- scripts/docs/templates/api_menu.template.html | 4 +--- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/scripts/docs/dgeni-config.js b/scripts/docs/dgeni-config.js index 954e08bf59..59519b99dc 100644 --- a/scripts/docs/dgeni-config.js +++ b/scripts/docs/dgeni-config.js @@ -67,7 +67,9 @@ module.exports = function(currentVersion){ var latestVersion = _.find(versions, semver.valid); versions = versions.map(function(version) { //Latest version is in docs root - var folder = version == latestVersion ? '' : version; + //var folder = version == latestVersion ? '' : version; + // Instead set nightly as docs root + var folder = version == 'nightly' ? '' : version; return { href: path.join('/' + config.v2DocsDir, folder), folder: folder, diff --git a/scripts/docs/templates/api_menu.template.html b/scripts/docs/templates/api_menu.template.html index 9cd013e797..c24fc8287f 100644 --- a/scripts/docs/templates/api_menu.template.html +++ b/scripts/docs/templates/api_menu.template.html @@ -1,14 +1,12 @@ <@ for ver in version.list @> - <@ if ver.name != version.latest.name @> <@ if loop.first @> {% if page.versionHref == "<$ ver.href $>" %} <@ else @> {% elsif page.versionHref == "<$ ver.href $>" %} <@ endif @> {% include v2_fluid/api_menu_flat_<$ ver.name $>.html %} - <@ endif @> <@ endfor @> <# make the last case always be to show latest version #> {% else %} - {% include v2_fluid/api_menu_flat_<$ version.latest.name $>.html %} + {% include v2_fluid/api_menu_flat_nightly.html %} {% endif %} From 82e49331b136f45f02eeaee3e97502be3eaa49d0 Mon Sep 17 00:00:00 2001 From: Drew Rygh Date: Fri, 4 Dec 2015 10:38:10 -0600 Subject: [PATCH 10/14] docs(events): basic usage --- ionic/util/events.ts | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/ionic/util/events.ts b/ionic/util/events.ts index afc2921710..7a38ef22d6 100644 --- a/ionic/util/events.ts +++ b/ionic/util/events.ts @@ -3,6 +3,20 @@ import {Injectable} from 'angular2/angular2'; /** * Events is a pub/sub style event system for sending and responding to application-level * events across your app. + * @usage + * ```ts + * // first page (publish an event when a user is created) + * function createUser(user) { + * console.log('User created!') + * events.publish('user:created', user); + * } + * + * // second page (listen for the user created event) + * events.subscribe('user:created', (user) => { + * console.log('Welcome', user); + * }); + * + * ``` */ @Injectable() export class Events { From 2c13de9c7b4a63d7b6ff63962fafd9e00b7ad75b Mon Sep 17 00:00:00 2001 From: Max Lynch Date: Fri, 4 Dec 2015 11:02:49 -0600 Subject: [PATCH 11/14] fix(platform): pass regexp to testNavigatorPlatform --- ionic/platform/platform.ts | 3 +-- ionic/platform/registry.ts | 4 ++-- 2 files changed, 3 insertions(+), 4 deletions(-) diff --git a/ionic/platform/platform.ts b/ionic/platform/platform.ts index cba958b23e..90d050833b 100644 --- a/ionic/platform/platform.ts +++ b/ionic/platform/platform.ts @@ -301,8 +301,7 @@ export class Platform { * @returns {boolean} TODO */ testNavigatorPlatform(navigatorPlatformExpression) { - let rgx = new RegExp(navigatorPlatformExpression, 'i'); - return rgx.test(this._bPlt || ''); + return navigatorPlatformExpression.test(this._bPlt || ''); } /** diff --git a/ionic/platform/registry.ts b/ionic/platform/registry.ts index f9481695b8..57233170df 100644 --- a/ionic/platform/registry.ts +++ b/ionic/platform/registry.ts @@ -52,7 +52,7 @@ Platform.register({ // however, under-powered devices shouldn't use ripple // if this a linux device, and is using Android Chrome v36 (Android 5.0) // or above then use ripple, otherwise do not use a ripple effect - if (p.testNavigatorPlatform('linux')) { + if (p.testNavigatorPlatform('/linux/i')) { let chromeVersion = p.matchUserAgentVersion(/Chrome\/(\d+).(\d+)?/); if (chromeVersion) { // linux android device using modern android chrome browser gets ripple @@ -175,5 +175,5 @@ function isIOSDevice(p) { // checks navigator.platform to see if it's an actual iOS device // this does not use the user-agent string because it is often spoofed // an actual iPad will return true, a chrome dev tools iPad will return false - return p.testNavigatorPlatform(/iphone|ipad|ipod/); + return p.testNavigatorPlatform(/iphone|ipad|ipod/i); } From 86a687a5dfd089dfe397b96eadca8c951fa1c7bb Mon Sep 17 00:00:00 2001 From: Max Lynch Date: Fri, 4 Dec 2015 11:38:58 -0600 Subject: [PATCH 12/14] fix(segment): tap acivation working. Fixes #663 --- ionic/components/segment/modes/ios.scss | 8 ++++---- ionic/components/segment/modes/md.scss | 7 ++++--- ionic/components/segment/segment.ts | 2 +- ionic/components/tap-click/tap-click.ts | 3 ++- 4 files changed, 11 insertions(+), 9 deletions(-) diff --git a/ionic/components/segment/modes/ios.scss b/ionic/components/segment/modes/ios.scss index 7070356231..e455aac04d 100644 --- a/ionic/components/segment/modes/ios.scss +++ b/ionic/components/segment/modes/ios.scss @@ -36,14 +36,14 @@ ion-segment { background: $segment-button-ios-bg-color; color: $segment-button-ios-bg-color-activated; - &.activated { + &.segment-activated { opacity: 1; color: $segment-button-ios-text-color; background-color: $segment-button-ios-bg-color-activated; transition: $segment-button-ios-activated-transition; } - &:hover:not(.activated) { + &:hover:not(.segment-activated) { background-color: rgba($segment-button-ios-bg-color-activated, $segment-button-ios-hover-opacity); } } @@ -95,13 +95,13 @@ ion-segment { background: $segment-button-ios-bg-color; color: $button-color; - &.activated { + &.segment-activated { opacity: 1; color: $activated-text-color; background-color: $button-color; } - &:hover:not(.activated) { + &:hover:not(.segment-activated) { background-color: rgba($button-color, $segment-button-ios-hover-opacity); } } diff --git a/ionic/components/segment/modes/md.scss b/ionic/components/segment/modes/md.scss index 1472b99bcb..958a3b041d 100644 --- a/ionic/components/segment/modes/md.scss +++ b/ionic/components/segment/modes/md.scss @@ -24,7 +24,7 @@ ion-segment { min-height: $segment-button-md-min-height; line-height: $segment-button-md-line-height; - &.activated { + &.activated, &.segment-activated { color: $segment-button-md-text-color-activated; background-color: transparent; border-color: $segment-button-md-border-color-activated; @@ -41,7 +41,8 @@ ion-segment { ion-segment { margin: 0 auto; - ion-segment-button[button][outline].activated { + ion-segment-button[button][outline].activated, + ion-segment-button[button][outline].segment-activated { background-color: transparent; } } @@ -57,7 +58,7 @@ ion-segment { &[outline] { color: $button-color; - &.activated { + &.activated, &.segment-activated { background-color: transparent; color: $button-color; border-color: $button-color; diff --git a/ionic/components/segment/segment.ts b/ionic/components/segment/segment.ts index e70dbcdce7..523e71f4d5 100644 --- a/ionic/components/segment/segment.ts +++ b/ionic/components/segment/segment.ts @@ -132,7 +132,7 @@ export class Segment extends Ion { ], host: { '(click)': 'click($event)', - '[class.activated]': 'isActive', + '[class.segment-activated]': 'isActive', } }) export class SegmentButton { diff --git a/ionic/components/tap-click/tap-click.ts b/ionic/components/tap-click/tap-click.ts index c59b122192..334a4591ec 100644 --- a/ionic/components/tap-click/tap-click.ts +++ b/ionic/components/tap-click/tap-click.ts @@ -62,6 +62,7 @@ export class TapClick { if (this.usePolyfill && this.startCoord && this.app.isEnabled()) { let endCoord = pointerCoord(ev); + if (!hasPointerMoved(POINTER_TOLERANCE, this.startCoord, endCoord)) { console.debug('create click from touch ' + Date.now()); @@ -206,7 +207,7 @@ function removeListener(type, listener) { } const ACTIVATABLE_ELEMENTS = /^(A|BUTTON)$/; -const ACTIVATABLE_ATTRIBUTES = /tappable/; +const ACTIVATABLE_ATTRIBUTES = /tappable|button/i; const POINTER_TOLERANCE = 4; const POINTER_MOVE_UNTIL_CANCEL = 10; const DISABLE_NATIVE_CLICK_AMOUNT = 2500; From 3f25687c1cf9fda0028e44e4959a2870fb452ada Mon Sep 17 00:00:00 2001 From: Drew Rygh Date: Fri, 4 Dec 2015 11:22:41 -0600 Subject: [PATCH 13/14] docs(labels): basic usage --- ionic/components/text-input/label.ts | 14 +++++++++++++- 1 file changed, 13 insertions(+), 1 deletion(-) diff --git a/ionic/components/text-input/label.ts b/ionic/components/text-input/label.ts index b55fea67ce..9c7a435e80 100644 --- a/ionic/components/text-input/label.ts +++ b/ionic/components/text-input/label.ts @@ -3,7 +3,19 @@ import {Directive, Optional} from 'angular2/angular2'; import {Config} from '../../config/config'; import {TextInput} from './text-input'; import {pointerCoord, hasPointerMoved} from '../../util/dom'; - +/** + * @name Label + * @description + * Labels describe the data that the user should enter in to an input element. + * @usage + * ```html + * + * Username + * + * + * ``` + * + */ @Directive({ selector: 'ion-label', From d1d40ba7ba883a1a81d57da2b7b7238d4baf2f48 Mon Sep 17 00:00:00 2001 From: Drew Rygh Date: Fri, 4 Dec 2015 11:54:10 -0600 Subject: [PATCH 14/14] docs(api): @see tag --- ionic/components/text-input/label.ts | 3 +++ scripts/docs/templates/common.template.html | 12 ++++++++++++ 2 files changed, 15 insertions(+) diff --git a/ionic/components/text-input/label.ts b/ionic/components/text-input/label.ts index 9c7a435e80..1e899a6a82 100644 --- a/ionic/components/text-input/label.ts +++ b/ionic/components/text-input/label.ts @@ -15,6 +15,9 @@ import {pointerCoord, hasPointerMoved} from '../../util/dom'; * * ``` * + * @see {@link ../../../../components#inputs Input Component Docs} + * @see {@link ../Input Input API Docs} + * */ @Directive({ diff --git a/scripts/docs/templates/common.template.html b/scripts/docs/templates/common.template.html index 8a72532a35..6948c341ea 100644 --- a/scripts/docs/templates/common.template.html +++ b/scripts/docs/templates/common.template.html @@ -235,6 +235,18 @@ Delegate: <$ doc.delegate $> + +<@- if doc.see @> + +

Related

+ +<@ for s in doc.see @> +<$ s | safe $> +<@- endfor -@> + +<@- endif -@> + + <@ endblock @>