mirror of
https://github.com/ionic-team/ionic-framework.git
synced 2025-08-18 19:21:34 +08:00
docs(api): add links to component sections
This commit is contained in:
@ -106,6 +106,8 @@ class ActionSheetCmp {
|
|||||||
*
|
*
|
||||||
* }
|
* }
|
||||||
* ```
|
* ```
|
||||||
|
*
|
||||||
|
* @see {@link /docs/v2/components#action-sheets ActionSheet Component Docs}
|
||||||
*/
|
*/
|
||||||
@Injectable()
|
@Injectable()
|
||||||
export class ActionSheet {
|
export class ActionSheet {
|
||||||
|
@ -26,6 +26,8 @@ import {Config} from '../../config/config';
|
|||||||
* @property [fab-bottom] - position a fab button towards the bottom
|
* @property [fab-bottom] - position a fab button towards the bottom
|
||||||
* @description
|
* @description
|
||||||
* Buttons are simple components in Ionic, can consist of text, an icon, or both, and can be enhanced with a wide range of attributes.
|
* Buttons are simple components in Ionic, can consist of text, an icon, or both, and can be enhanced with a wide range of attributes.
|
||||||
|
* @see {@link /docs/v2/components#buttons Button Component Docs}
|
||||||
|
|
||||||
*/
|
*/
|
||||||
@Directive({
|
@Directive({
|
||||||
selector: 'button,[button]'
|
selector: 'button,[button]'
|
||||||
|
@ -17,6 +17,7 @@ import {Form} from '../../util/form';
|
|||||||
* HTML5
|
* HTML5
|
||||||
* </ion-checkbox>
|
* </ion-checkbox>
|
||||||
* ```
|
* ```
|
||||||
|
* @see {@link /docs/v2/components#checkbox Checkbox Component Docs}
|
||||||
*/
|
*/
|
||||||
@Component({
|
@Component({
|
||||||
selector: 'ion-checkbox',
|
selector: 'ion-checkbox',
|
||||||
|
@ -13,6 +13,7 @@ import {Config} from '../../config/config';
|
|||||||
* If there is not an outlined version for the particular icon, it will use the default (full) version.
|
* 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} [ios] - Explicitly set the icon to use on iOS.
|
||||||
* @property {string} [md] - Explicitly set the icon to use on Android.
|
* @property {string} [md] - Explicitly set the icon to use on Android.
|
||||||
|
* @see {@link /docs/v2/components#icons Icon Component Docs}
|
||||||
*
|
*
|
||||||
*/
|
*/
|
||||||
@Directive({
|
@Directive({
|
||||||
|
@ -37,6 +37,8 @@ import {Component} from 'angular2/angular2';
|
|||||||
* </ion-list>
|
* </ion-list>
|
||||||
*
|
*
|
||||||
* ```
|
* ```
|
||||||
|
* @see {@link /docs/v2/components#lists List Component Docs}
|
||||||
|
* @see {@link ../../list/List List API Docs}
|
||||||
*/
|
*/
|
||||||
@Component({
|
@Component({
|
||||||
selector: 'ion-item,[ion-item]',
|
selector: 'ion-item,[ion-item]',
|
||||||
|
@ -16,6 +16,7 @@ import * as util from 'ionic/util';
|
|||||||
* Using the List and Item components make it easy to support various
|
* Using the List and Item components make it easy to support various
|
||||||
* interaction modes such as swipe to edit, drag to reorder, and removing items.
|
* interaction modes such as swipe to edit, drag to reorder, and removing items.
|
||||||
* @demo /docs/v2/demos/list/
|
* @demo /docs/v2/demos/list/
|
||||||
|
* @see {@link /docs/v2/components#lists List Component Docs}
|
||||||
*
|
*
|
||||||
*
|
*
|
||||||
*/
|
*/
|
||||||
|
@ -6,6 +6,8 @@ import {IonicApp} from '../app/app';
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* TODO
|
* TODO
|
||||||
|
* @see {@link /docs/v2/components#menus Menu Component Docs}
|
||||||
|
* @see {@link ../../menu/Menu Menu API Docs}
|
||||||
*/
|
*/
|
||||||
@Directive({
|
@Directive({
|
||||||
selector: '[menu-close]',
|
selector: '[menu-close]',
|
||||||
|
@ -8,6 +8,8 @@ import {Navbar} from '../navbar/navbar';
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* TODO
|
* TODO
|
||||||
|
* @see {@link /docs/v2/components#menus Menu Component Docs}
|
||||||
|
* @see {@link ../../menu/Menu Menu API Docs}
|
||||||
*/
|
*/
|
||||||
@Directive({
|
@Directive({
|
||||||
selector: '[menu-toggle]',
|
selector: '[menu-toggle]',
|
||||||
|
@ -7,6 +7,7 @@ import {Animation} from 'ionic/animations/animation';
|
|||||||
* Base class which is extended by the various types. Each
|
* Base class which is extended by the various types. Each
|
||||||
* type will provide their own animations for open and close
|
* type will provide their own animations for open and close
|
||||||
* and registers itself with Menu.
|
* and registers itself with Menu.
|
||||||
|
* @private
|
||||||
*/
|
*/
|
||||||
export class MenuType {
|
export class MenuType {
|
||||||
|
|
||||||
|
@ -42,6 +42,10 @@ import * as gestures from './menu-gestures';
|
|||||||
* ```html
|
* ```html
|
||||||
* <ion-menu [content]="contentRef" type="overlay"></ion-menu>
|
* <ion-menu [content]="contentRef" type="overlay"></ion-menu>
|
||||||
* ```
|
* ```
|
||||||
|
* @see {@link /docs/v2/components#menus Menu Component Docs}
|
||||||
|
* @see {@link /docs/v2/components#navigation Navigation Component Docs}
|
||||||
|
* @see {@link ../../nav/Nav Nav API Docs}
|
||||||
|
*
|
||||||
*/
|
*/
|
||||||
@Component({
|
@Component({
|
||||||
selector: 'ion-menu',
|
selector: 'ion-menu',
|
||||||
|
@ -33,6 +33,7 @@ import {extend} from 'ionic/util';
|
|||||||
*
|
*
|
||||||
* }
|
* }
|
||||||
* ```
|
* ```
|
||||||
|
* @see {@link /docs/v2/components#modals Modal Component Docs}
|
||||||
*/
|
*/
|
||||||
@Injectable()
|
@Injectable()
|
||||||
export class Modal {
|
export class Modal {
|
||||||
|
@ -97,6 +97,7 @@ import {raf, rafFrames} from '../../util/dom';
|
|||||||
* - `onPageWillUnload` - Runs when the page is about to be destroyed and have its elements removed.
|
* - `onPageWillUnload` - Runs when the page is about to be destroyed and have its elements removed.
|
||||||
* - `onPageDidUnload` - Runs after the page has been destroyed and its elements have been removed.
|
* - `onPageDidUnload` - Runs after the page has been destroyed and its elements have been removed.
|
||||||
*
|
*
|
||||||
|
* @see {@link /docs/v2/components#navigation Navigation Component Docs}
|
||||||
*/
|
*/
|
||||||
export class NavController extends Ion {
|
export class NavController extends Ion {
|
||||||
|
|
||||||
|
@ -36,6 +36,7 @@ import {NavRegistry} from './nav-registry';
|
|||||||
* ```html
|
* ```html
|
||||||
* <button [nav-push]="[pushPage, params]"></button>
|
* <button [nav-push]="[pushPage, params]"></button>
|
||||||
* ```
|
* ```
|
||||||
|
* @see {@link /docs/v2/components#navigation Navigation Component Docs}
|
||||||
*/
|
*/
|
||||||
@Directive({
|
@Directive({
|
||||||
selector: '[nav-push]',
|
selector: '[nav-push]',
|
||||||
|
@ -96,6 +96,7 @@ import {ViewController} from './view-controller';
|
|||||||
* </pre>
|
* </pre>
|
||||||
* </div>
|
* </div>
|
||||||
*
|
*
|
||||||
|
* @see {@link /docs/v2/components#navigation Navigation Component Docs}
|
||||||
*/
|
*/
|
||||||
@ConfigComponent({
|
@ConfigComponent({
|
||||||
selector: 'ion-nav',
|
selector: 'ion-nav',
|
||||||
|
@ -61,6 +61,7 @@ import {extend} from '../../util/util';
|
|||||||
* }
|
* }
|
||||||
* }
|
* }
|
||||||
* ```
|
* ```
|
||||||
|
* @see {@link /docs/v2/components#popups Popup Component Docs}
|
||||||
*/
|
*/
|
||||||
@Injectable()
|
@Injectable()
|
||||||
export class Popup {
|
export class Popup {
|
||||||
|
@ -40,6 +40,7 @@ import {ListHeader} from '../list/list';
|
|||||||
*
|
*
|
||||||
* </ion-list>
|
* </ion-list>
|
||||||
* ```
|
* ```
|
||||||
|
* @see {@link /docs/v2/components#radio Radio Component Docs}
|
||||||
*/
|
*/
|
||||||
@Directive({
|
@Directive({
|
||||||
selector: '[radio-group]',
|
selector: '[radio-group]',
|
||||||
@ -162,6 +163,7 @@ export class RadioGroup extends Ion {
|
|||||||
* </ion-radio>
|
* </ion-radio>
|
||||||
* ```
|
* ```
|
||||||
*
|
*
|
||||||
|
* @see {@link /docs/v2/components#radio Radio Component Docs}
|
||||||
*/
|
*/
|
||||||
@Component({
|
@Component({
|
||||||
selector: 'ion-radio',
|
selector: 'ion-radio',
|
||||||
|
@ -20,6 +20,7 @@ import {Icon} from '../icon/icon';
|
|||||||
* @property [show-cancel] - shows the cancel button based on boolean value passed in
|
* @property [show-cancel] - shows the cancel button based on boolean value passed in
|
||||||
* @property [cancel-text] - sets the cancel button text to the value passed in
|
* @property [cancel-text] - sets the cancel button text to the value passed in
|
||||||
* @property [cancel-action] - the function that gets called by clicking the cancel button
|
* @property [cancel-action] - the function that gets called by clicking the cancel button
|
||||||
|
* @see {@link /docs/v2/components#search Search Component Docs}
|
||||||
*/
|
*/
|
||||||
@ConfigComponent({
|
@ConfigComponent({
|
||||||
selector: 'ion-searchbar',
|
selector: 'ion-searchbar',
|
||||||
|
@ -36,6 +36,8 @@ import {Config} from '../../config/config';
|
|||||||
* </ion-segment>
|
* </ion-segment>
|
||||||
* </form>
|
* </form>
|
||||||
* ```
|
* ```
|
||||||
|
*
|
||||||
|
* @see {@link /docs/v2/components#segment Segment Component Docs}
|
||||||
*/
|
*/
|
||||||
@Directive({
|
@Directive({
|
||||||
selector: 'ion-segment'
|
selector: 'ion-segment'
|
||||||
|
@ -27,6 +27,7 @@ import {Scroll} from '../scroll/scroll';
|
|||||||
*
|
*
|
||||||
* Licensed under MIT
|
* Licensed under MIT
|
||||||
*
|
*
|
||||||
|
* @see {@link /docs/v2/components#slides Slides Component Docs}
|
||||||
*/
|
*/
|
||||||
@Component({
|
@Component({
|
||||||
selector: 'ion-slides',
|
selector: 'ion-slides',
|
||||||
|
@ -64,6 +64,7 @@ class MediaSwitch {
|
|||||||
* </ion-list>
|
* </ion-list>
|
||||||
* ```
|
* ```
|
||||||
*
|
*
|
||||||
|
* @see {@link /docs/v2/components#switch Switch Component Docs}
|
||||||
*/
|
*/
|
||||||
@Component({
|
@Component({
|
||||||
selector: 'ion-switch',
|
selector: 'ion-switch',
|
||||||
|
@ -31,8 +31,8 @@ import {rafFrames} from '../../util/dom';
|
|||||||
* individual Tab components. On iOS, the TabBar is placed on the bottom of
|
* individual Tab components. On iOS, the TabBar is placed on the bottom of
|
||||||
* the screen, while on Android it is at the top.
|
* the screen, while on Android it is at the top.
|
||||||
*
|
*
|
||||||
* See the [Tab API reference](../Tab/) for more details on individual Tab components.
|
* @see {@link /docs/v2/components#tabs Tabs Component Docs}
|
||||||
*
|
* @see {@link ../Tab Tab API Docs}
|
||||||
*/
|
*/
|
||||||
@ConfigComponent({
|
@ConfigComponent({
|
||||||
selector: 'ion-tabs',
|
selector: 'ion-tabs',
|
||||||
|
3
scripts/docs/templates/common.template.html
vendored
3
scripts/docs/templates/common.template.html
vendored
@ -222,8 +222,7 @@ Delegate: <$ doc.delegate $>
|
|||||||
|
|
||||||
<@- if doc.see @>
|
<@- if doc.see @>
|
||||||
|
|
||||||
<h2>Related</h2>
|
<h2>Related</h2>
|
||||||
|
|
||||||
<@ for s in doc.see @>
|
<@ for s in doc.see @>
|
||||||
<$ s | safe $>
|
<$ s | safe $>
|
||||||
<@- endfor -@>
|
<@- endfor -@>
|
||||||
|
Reference in New Issue
Block a user