mirror of
https://github.com/ionic-team/ionic-framework.git
synced 2025-08-18 19:21:34 +08:00
chore(): begin adding ionic components to mono-repo.
This commit is contained in:
Josh Thomas
25
packages/ionic-angular/scripts/docs/templates/api_index.template.html
vendored
Normal file
25
packages/ionic-angular/scripts/docs/templates/api_index.template.html
vendored
Normal file
@ -0,0 +1,25 @@
|
||||
---
|
||||
layout: "fluid/docs_base"
|
||||
version: "<$ version.current.name $>"
|
||||
versionHref: "<$ version.current.href $>"
|
||||
path: ""
|
||||
|
||||
category: api
|
||||
id: api
|
||||
title: Javascript
|
||||
header_sub_title: Extend Ionic even further with the power of AngularJS
|
||||
searchable: false
|
||||
---
|
||||
|
||||
# Ionic API Docs
|
||||
|
||||
<img class="section-header" src="/img/docs/api-intro-header.png" />
|
||||
|
||||
|
||||
Ionic takes everything you know and loved about Ionic V1, and builds on top of it to provide a much more flexible framework.
|
||||
|
||||
In the API docs, you'll find two kinds of doc pages: Component and Service APIs.
|
||||
|
||||
The Component APIs include classes like `Checkbox`, `Toggle` or `Item` and show you how to use them, in addition to listing their selectors, available properties and events.
|
||||
|
||||
The Service APIs are classes like `MenuController`, `Config` or `Platform`. These are services provided by Ionic that can be injected into your classes.
|
||||
14
packages/ionic-angular/scripts/docs/templates/api_menu.template.html
vendored
Normal file
14
packages/ionic-angular/scripts/docs/templates/api_menu.template.html
vendored
Normal file
@ -0,0 +1,14 @@
|
||||
<@ 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 fluid/api_menu_flat_<$ ver.name $>.html %}
|
||||
<@ endif @>
|
||||
<@ endfor @>
|
||||
<# make the last case always be to show latest version #>
|
||||
{% else %}
|
||||
{% include fluid/api_menu_flat_<$ version.latest.name $>.html %}
|
||||
{% endif %}
|
||||
4
packages/ionic-angular/scripts/docs/templates/api_menu_flat_version.template.html
vendored
Normal file
4
packages/ionic-angular/scripts/docs/templates/api_menu_flat_version.template.html
vendored
Normal file
@ -0,0 +1,4 @@
|
||||
<@ for doc in docs @><@ if doc.URL and doc.private != true and doc.name @>
|
||||
<li class="capitalize {% if page.id == '<$ doc.name|lower|replace(' ','-')$>' %}active{% endif %}">
|
||||
<a href="/<$ doc.URL $>"><$ doc.name $></a>
|
||||
</li><@ endif @><@ endfor @>
|
||||
681
packages/ionic-angular/scripts/docs/templates/api_menu_version.template.html
vendored
Normal file
681
packages/ionic-angular/scripts/docs/templates/api_menu_version.template.html
vendored
Normal file
@ -0,0 +1,681 @@
|
||||
|
||||
|
||||
|
||||
<!-- App -->
|
||||
<li class="menu-section">
|
||||
<a href="{{ page.versionHref }}/api/components/app/IonicApp/" class="api-section">
|
||||
App
|
||||
</a>
|
||||
<ul>
|
||||
<li>
|
||||
<a href="{{ page.versionHref }}/api/components/app/IonicApp/">
|
||||
IonicApp
|
||||
</a>
|
||||
</li>
|
||||
|
||||
<li>
|
||||
<a href="{{ page.versionHref }}/api/components/app/ionicBootStrap/">
|
||||
ionicBootstrap
|
||||
</a>
|
||||
</li>
|
||||
|
||||
<li>
|
||||
<a href="{{ page.versionHref }}/api/components/app/IdRef/">
|
||||
IdRef
|
||||
</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
|
||||
<!-- ActionSheet -->
|
||||
<li class="menu-section">
|
||||
<a href="{{ page.versionHref }}/api/components/action-sheet/ActionSheet/" class="api-section">
|
||||
ActionSheet
|
||||
</a>
|
||||
<ul>
|
||||
<li>
|
||||
<a href="{{ page.versionHref }}/api/components/action-sheet/ActionSheet/">
|
||||
ActionSheet
|
||||
</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
|
||||
<!-- Button -->
|
||||
<li class="menu-section">
|
||||
<a href="{{ page.versionHref }}/api/components/button/Button/" class="api-section">
|
||||
Button
|
||||
</a>
|
||||
<ul>
|
||||
<li>
|
||||
<a href="{{ page.versionHref }}/api/components/button/Button/">
|
||||
Button
|
||||
</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="{{ page.versionHref }}/api/components/button/TapDisabled/">
|
||||
TapDisabled
|
||||
</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="{{ page.versionHref }}/api/components/button/TapClick/">
|
||||
TapClick
|
||||
</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
|
||||
<!-- Card -->
|
||||
<li class="menu-section">
|
||||
<a href="{{ page.versionHref }}/api/components/card/Card/" class="api-section">
|
||||
Card
|
||||
</a>
|
||||
<ul>
|
||||
<li>
|
||||
<a href="{{ page.versionHref }}/api/components/card/Card/">
|
||||
Card
|
||||
</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
|
||||
<!-- Checkbox -->
|
||||
<li class="menu-section">
|
||||
<a href="{{ page.versionHref }}/api/components/checkbox/Checkbox/" class="api-section">
|
||||
Checkbox
|
||||
</a>
|
||||
<ul>
|
||||
<li>
|
||||
<a href="{{ page.versionHref }}/api/components/checkbox/Checkbox/">
|
||||
Checkbox
|
||||
</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
|
||||
<!-- Content -->
|
||||
<li class="menu-section">
|
||||
<a href="{{ page.versionHref }}/api/components/content/Content/" class="api-section">
|
||||
Content
|
||||
</a>
|
||||
<ul>
|
||||
<li>
|
||||
<a href="{{ page.versionHref }}/api/components/content/Content/">
|
||||
Content
|
||||
</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
|
||||
<!-- Icon -->
|
||||
<li class="menu-section">
|
||||
<a href="{{ page.versionHref }}/api/components/icon/Icon/" class="api-section">
|
||||
Icon
|
||||
</a>
|
||||
<ul>
|
||||
<li>
|
||||
<a href="{{ page.versionHref }}/api/components/icon/Icon/">
|
||||
Icon
|
||||
</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
|
||||
<!-- IonItem -->
|
||||
<li class="menu-section">
|
||||
<a href="{{ page.versionHref }}/api/components/item/IonItem/" class="api-section">
|
||||
IonItem
|
||||
</a>
|
||||
<ul>
|
||||
<li>
|
||||
<a href="{{ page.versionHref }}/api/components/item/IonItem/">
|
||||
IonItem
|
||||
</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="{{ page.versionHref }}/api/components/item/ItemGroup/">
|
||||
ItemGroup
|
||||
</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="{{ page.versionHref }}/api/components/item/ItemGroupTitle/">
|
||||
ItemGroupTitle
|
||||
</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
|
||||
<!-- IonInput -->
|
||||
<li class="menu-section">
|
||||
<a href="{{ page.versionHref }}/api/components/form/IonInput/" class="api-section">
|
||||
IonInput
|
||||
</a>
|
||||
<ul>
|
||||
<li>
|
||||
<a href="{{ page.versionHref }}/api/components/form/IonInput/">
|
||||
IonInput
|
||||
</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
|
||||
<!-- TextInput -->
|
||||
<li class="menu-section">
|
||||
<a href="{{ page.versionHref }}/api/components/text-input/TextInput/" class="api-section">
|
||||
TextInput
|
||||
</a>
|
||||
<ul>
|
||||
<li>
|
||||
<a href="{{ page.versionHref }}/api/components/text-input/TextInput/">
|
||||
TextInput
|
||||
</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="{{ page.versionHref }}/api/components/text-input/TextInputElement/">
|
||||
TextInputElement
|
||||
</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="{{ page.versionHref }}/api/components/label/label/">
|
||||
Label
|
||||
</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
|
||||
<!-- IonList -->
|
||||
<li class="menu-section">
|
||||
<a href="{{ page.versionHref }}/api/components/list/IonList/" class="api-section">
|
||||
IonList
|
||||
</a>
|
||||
<ul>
|
||||
<li>
|
||||
<a href="{{ page.versionHref }}/api/components/list/IonList/">
|
||||
IonList
|
||||
</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="{{ page.versionHref }}/api/components/list/ListHeader/">
|
||||
ListHeader
|
||||
</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
|
||||
<!-- ShowWhen -->
|
||||
<li class="menu-section">
|
||||
<a href="{{ page.versionHref }}/api/components/show-hide-when/ShowWhen/" class="api-section">
|
||||
ShowWhen
|
||||
</a>
|
||||
<ul>
|
||||
<li>
|
||||
<a href="{{ page.versionHref }}/api/components/show-hide-when/ShowWhen/">
|
||||
ShowWhen
|
||||
</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
|
||||
<!-- HideWhen -->
|
||||
<li class="menu-section">
|
||||
<a href="{{ page.versionHref }}/api/components/show-hide-when/HideWhen/" class="api-section">
|
||||
HideWhen
|
||||
</a>
|
||||
<ul>
|
||||
<li>
|
||||
<a href="{{ page.versionHref }}/api/components/show-hide-when/HideWhen/">
|
||||
HideWhen
|
||||
</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
|
||||
<!-- MaterialButton -->
|
||||
<li class="menu-section">
|
||||
<a href="{{ page.versionHref }}/api/components/material/MaterialButton/" class="api-section">
|
||||
MaterialButton
|
||||
</a>
|
||||
<ul>
|
||||
<li>
|
||||
<a href="{{ page.versionHref }}/api/components/material/MaterialButton/">
|
||||
MaterialButton
|
||||
</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="{{ page.versionHref }}/api/components/material/MaterialRippleEffect/">
|
||||
MaterialRippleEffect
|
||||
</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
|
||||
<!-- Menu -->
|
||||
<li class="menu-section">
|
||||
<a href="{{ page.versionHref }}/api/components/menu/Menu/" class="api-section">
|
||||
Menu
|
||||
</a>
|
||||
<ul>
|
||||
<li>
|
||||
<a href="{{ page.versionHref }}/api/components/menu/Menu/">
|
||||
Menu
|
||||
</a>
|
||||
</li>
|
||||
|
||||
<li>
|
||||
<a href="{{ page.versionHref }}/api/components/menu/MenuToggle/">
|
||||
MenuToggle
|
||||
</a>
|
||||
</li>
|
||||
|
||||
<li>
|
||||
<a href="{{ page.versionHref }}/api/components/menu/MenuType/">
|
||||
MenuType
|
||||
</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
|
||||
<!-- Modal -->
|
||||
<li class="menu-section">
|
||||
<a href="{{ page.versionHref }}/api/components/modal/ionModal/" class="api-section">
|
||||
Modal
|
||||
</a>
|
||||
<ul>
|
||||
<li>
|
||||
<a href="{{ page.versionHref }}/api/components/modal/ionModal/">
|
||||
Modal
|
||||
</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
|
||||
<!-- Nav -->
|
||||
<li class="menu-section">
|
||||
<a href="{{ page.versionHref }}/api/components/nav/Nav/" class="api-section">
|
||||
Nav
|
||||
</a>
|
||||
<ul>
|
||||
<li>
|
||||
<a href="{{ page.versionHref }}/api/components/nav/Nav/">
|
||||
Nav
|
||||
</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="{{ page.versionHref }}/api/components/nav/NavController/">
|
||||
NavController
|
||||
</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="{{ page.versionHref }}/api/components/nav/NavParams/">
|
||||
NavParams
|
||||
</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="{{ page.versionHref }}/api/components/nav/NavPush/">
|
||||
NavPush
|
||||
</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="{{ page.versionHref }}/api/components/nav/NavPop/">
|
||||
NavPop
|
||||
</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="{{ page.versionHref }}/api/components/nav/NavRouter/">
|
||||
NavRouter
|
||||
</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
|
||||
<!-- NavBar -->
|
||||
<li class="menu-section">
|
||||
<a href="{{ page.versionHref }}/api/components/navbar/NavBar/" class="api-section">
|
||||
NavBar
|
||||
</a>
|
||||
<ul>
|
||||
<li>
|
||||
<a href="{{ page.versionHref }}/api/components/navbar/NavBar/">
|
||||
NavBar
|
||||
</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="{{ page.versionHref }}/api/components/navbar/NavbarTemplate/">
|
||||
NavbarTemplate
|
||||
</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
|
||||
<!-- Popup -->
|
||||
<li class="menu-section">
|
||||
<a href="{{ page.versionHref }}/api/components/popup/ionPopup/" class="api-section">
|
||||
Popup
|
||||
</a>
|
||||
<ul>
|
||||
<li>
|
||||
<a href="{{ page.versionHref }}/api/components/popup/ionPopup/">
|
||||
Popup
|
||||
</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
|
||||
<!-- Slides -->
|
||||
<li class="menu-section">
|
||||
<a href="{{ page.versionHref }}/api/components/slides/Slides/" class="api-section">
|
||||
Slides
|
||||
</a>
|
||||
<ul>
|
||||
<li>
|
||||
<a href="{{ page.versionHref }}/api/components/slides/Slides/">
|
||||
Slides
|
||||
</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="{{ page.versionHref }}/api/components/slides/Slide/">
|
||||
Slide
|
||||
</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="{{ page.versionHref }}/api/components/slides/SlideLazy/">
|
||||
SlideLazy
|
||||
</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
|
||||
<!-- Radio -->
|
||||
<li class="menu-section">
|
||||
<a href="{{ page.versionHref }}/api/components/radio/RadioGroup/" class="api-section">
|
||||
Radio
|
||||
</a>
|
||||
<ul>
|
||||
<li>
|
||||
<a href="{{ page.versionHref }}/api/components/radio/RadioGroup/">
|
||||
RadioGroup
|
||||
</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="{{ page.versionHref }}/api/components/radio/RadioButton/">
|
||||
RadioButton
|
||||
</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
|
||||
<!-- Scroll -->
|
||||
<li class="menu-section">
|
||||
<a href="{{ page.versionHref }}/api/components/scroll/Scroll/" class="api-section">
|
||||
Scroll
|
||||
</a>
|
||||
<ul>
|
||||
<li>
|
||||
<a href="{{ page.versionHref }}/api/components/scroll/Scroll/">
|
||||
Scroll
|
||||
</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="{{ page.versionHref }}/api/components/scroll/Refresher/">
|
||||
Refresher
|
||||
</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
|
||||
<!-- SearchBar -->
|
||||
<li class="menu-section">
|
||||
<a href="{{ page.versionHref }}/api/components/searchbar/SearchBar/" class="api-section">
|
||||
SearchBar
|
||||
</a>
|
||||
<ul>
|
||||
<li>
|
||||
<a href="{{ page.versionHref }}/api/components/searchbar/SearchBar/">
|
||||
SearchBar
|
||||
</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
|
||||
<!-- Segment -->
|
||||
<li class="menu-section">
|
||||
<a href="{{ page.versionHref }}/api/components/segment/Segment/" class="api-section">
|
||||
Segment
|
||||
</a>
|
||||
<ul>
|
||||
<li>
|
||||
<a href="{{ page.versionHref }}/api/components/segment/Segment/">
|
||||
Segment
|
||||
</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="{{ page.versionHref }}/api/components/segment/SegmentControlValueAccessor/">
|
||||
SegmentControlValueAccessor
|
||||
</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="{{ page.versionHref }}/api/components/segment/SegmentButton/">
|
||||
SegmentButton
|
||||
</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
|
||||
<!-- Switch -->
|
||||
<li class="menu-section">
|
||||
<a href="{{ page.versionHref }}/api/components/switch/Switch/" class="api-section">
|
||||
Switch
|
||||
</a>
|
||||
<ul>
|
||||
<li>
|
||||
<a href="{{ page.versionHref }}/api/components/switch/Switch/">
|
||||
Switch
|
||||
</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
|
||||
<!-- IonTabs -->
|
||||
<li class="menu-section">
|
||||
<a href="{{ page.versionHref }}/api/components/tabs/IonTabs/" class="api-section">
|
||||
IonTabs
|
||||
</a>
|
||||
<ul>
|
||||
<li>
|
||||
<a href="{{ page.versionHref }}/api/components/tabs/IonTabs/">
|
||||
IonTabs
|
||||
</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="{{ page.versionHref }}/api/components/tabs/IonTab/">
|
||||
IonTab
|
||||
</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
|
||||
<!-- Toolbar -->
|
||||
<li class="menu-section">
|
||||
<a href="{{ page.versionHref }}/api/components/toolbar/Toolbar/" class="api-section">
|
||||
Toolbar
|
||||
</a>
|
||||
<ul>
|
||||
<li>
|
||||
<a href="{{ page.versionHref }}/api/components/toolbar/Toolbar/">
|
||||
Toolbar
|
||||
</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="{{ page.versionHref }}/api/components/toolbar/ToolbarBase/">
|
||||
ToolbarBase
|
||||
</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
|
||||
<!-- View -->
|
||||
<li class="menu-section">
|
||||
<a href="{{ page.versionHref }}/api/components/view/View/" class="api-section">
|
||||
View
|
||||
</a>
|
||||
<ul>
|
||||
<li>
|
||||
<a href="{{ page.versionHref }}/api/components/view/ViewItem/">
|
||||
ViewItem
|
||||
</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
|
||||
|
||||
<!-- Animations -->
|
||||
<li class="menu-section">
|
||||
<a href="{{ page.versionHref }}/api/animations/Animation/" class="api-section">
|
||||
Animations
|
||||
</a>
|
||||
<ul>
|
||||
<li>
|
||||
<a href="{{ page.versionHref }}/api/animations/Animation/">
|
||||
Animation
|
||||
</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
|
||||
|
||||
<!-- Transitions -->
|
||||
<li class="menu-section">
|
||||
<a href="{{ page.versionHref }}/api/transitions/Transition/" class="api-section">
|
||||
Transitions
|
||||
</a>
|
||||
<ul>
|
||||
<li>
|
||||
<a href="{{ page.versionHref }}/api/transitions/Transition/">
|
||||
Transition
|
||||
</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
|
||||
|
||||
<!-- Config -->
|
||||
<li class="menu-section">
|
||||
<a href="{{ page.versionHref }}/api/config/Config/" class="api-section">
|
||||
Config
|
||||
</a>
|
||||
<ul>
|
||||
<li>
|
||||
<a href="{{ page.versionHref }}/api/config/Config/">
|
||||
Config
|
||||
</a>
|
||||
</li>
|
||||
|
||||
<li>
|
||||
<a href="{{ page.versionHref }}/api/config/IonicDirectives/">
|
||||
IonicDirectives
|
||||
</a>
|
||||
</li>
|
||||
|
||||
<li>
|
||||
<a href="{{ page.versionHref }}/api/config/IonicView/">
|
||||
IonicDirectives
|
||||
</a>
|
||||
</li>
|
||||
|
||||
<li>
|
||||
<a href="{{ page.versionHref }}/api/config/IonicComponent/">
|
||||
IonicDirectives
|
||||
</a>
|
||||
</li>
|
||||
|
||||
<li>
|
||||
<a href="{{ page.versionHref }}/api/config/App/">
|
||||
App
|
||||
</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
|
||||
|
||||
<!-- Net -->
|
||||
<li class="menu-section">
|
||||
<a href="{{ page.versionHref }}/api/net/Http/" class="api-section">
|
||||
Net
|
||||
</a>
|
||||
<ul>
|
||||
<li>
|
||||
<a href="{{ page.versionHref }}/api/net/Http/">
|
||||
HTTP
|
||||
</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
|
||||
|
||||
<!-- Platform -->
|
||||
<li class="menu-section">
|
||||
<a href="{{ page.versionHref }}/api/platform/Platform/" class="api-section">
|
||||
Platform
|
||||
</a>
|
||||
<ul>
|
||||
<li>
|
||||
<a href="{{ page.versionHref }}/api/platform/Platform/">
|
||||
Platform
|
||||
</a>
|
||||
</li>
|
||||
|
||||
<li>
|
||||
<a href="{{ page.versionHref }}/api/platform/PlatformCtrl/">
|
||||
PlatformCtrl
|
||||
</a>
|
||||
</li>
|
||||
|
||||
</ul>
|
||||
</li>
|
||||
|
||||
|
||||
<!-- Util -->
|
||||
<li class="menu-section">
|
||||
<a href="{{ page.versionHref }}/api/util/ClickBlock/" class="api-section">
|
||||
Util
|
||||
</a>
|
||||
<ul>
|
||||
<li>
|
||||
<a href="{{ page.versionHref }}/api/util/ClickBlock/">
|
||||
Click Block
|
||||
</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
|
||||
<!-- Storage -->
|
||||
<li class="menu-section">
|
||||
<a href="{{ page.versionHref }}/api/storage/Storage/" class="api-section">
|
||||
Storage
|
||||
</a>
|
||||
<ul>
|
||||
<li>
|
||||
<a href="{{ page.versionHref }}/api/storage/Storage/">
|
||||
Storage
|
||||
</a>
|
||||
</li>
|
||||
|
||||
<li>
|
||||
<a href="{{ page.versionHref }}/api/storage/StorageEngine/">
|
||||
StorageEngine
|
||||
</a>
|
||||
</li>
|
||||
|
||||
<li>
|
||||
<a href="{{ page.versionHref }}/api/storage/SqlStorage/">
|
||||
SqlStorage
|
||||
</a>
|
||||
</li>
|
||||
|
||||
<li>
|
||||
<a href="{{ page.versionHref }}/api/storage/LocalStorage">
|
||||
LocalStorage
|
||||
</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
11
packages/ionic-angular/scripts/docs/templates/api_version_select.template.html
vendored
Normal file
11
packages/ionic-angular/scripts/docs/templates/api_version_select.template.html
vendored
Normal file
@ -0,0 +1,11 @@
|
||||
<select name="version"
|
||||
id="version-toggle"
|
||||
onchange="window.location.href=this.options[this.selectedIndex].value">
|
||||
<@ for ver in version.list @>
|
||||
<option
|
||||
value="<$ ver.href $>/{% if page.path != ''%}{{page.path}}{% else %}api/{% endif %}"
|
||||
{% if page.version == "<$ ver.name $>"%}selected{% endif %}>
|
||||
<$ ver.name $> <@ if version.latest.name == ver.name @>(latest)<@ endif @>
|
||||
</option>
|
||||
<@ endfor @>
|
||||
</select>
|
||||
408
packages/ionic-angular/scripts/docs/templates/common.template.html
vendored
Normal file
408
packages/ionic-angular/scripts/docs/templates/common.template.html
vendored
Normal file
@ -0,0 +1,408 @@
|
||||
---
|
||||
layout: "fluid/docs_base"
|
||||
version: "<$ version.current.name $>"
|
||||
versionHref: "<$ version.current.href $>"
|
||||
path: "<$ doc.path $>"
|
||||
category: api
|
||||
id: "<$ doc.name|lower|replace(' ','-') $>"
|
||||
title: "<@ if doc.docType == "directive" @><$ doc.name | dashCase $><@ else @><$ doc.name $><@ endif @>"
|
||||
header_sub_title: "Ionic API Documentation"
|
||||
doc: "<$ doc.name $>"
|
||||
docType: "<$ doc.docType $>"
|
||||
<@ if doc.demo @>show_preview_device: true
|
||||
preview_device_url: "<$ doc.demo $>www/"
|
||||
angular_controller: APIDemoCtrl <@ endif @>
|
||||
---
|
||||
|
||||
|
||||
<@ macro paramList(paramData) -@>
|
||||
<@- if paramData -@><span class="params">(
|
||||
<@- for param in paramData -@>
|
||||
<span class="param"><$ param | escape $><@ if not loop.last @>, <@ endif @></span>
|
||||
<@- endfor @>)</span>
|
||||
<@- endif @>
|
||||
<@- endmacro -@>
|
||||
|
||||
<@ macro returnObject(params) -@>
|
||||
<@- if params -@>
|
||||
<table class="table returns-object-table param-table">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Property</th>
|
||||
<th>Type</th>
|
||||
<th>Details</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<@ for param in params @>
|
||||
<tr>
|
||||
<td class="fixed-width">
|
||||
<$ param.key $>
|
||||
</td>
|
||||
<td>
|
||||
<$ param.type | code $>
|
||||
</td>
|
||||
<td>
|
||||
<$ param.description | marked $>
|
||||
</td>
|
||||
</tr>
|
||||
<@ endfor @>
|
||||
</tbody>
|
||||
</table>
|
||||
<@- endif @>
|
||||
<@- endmacro -@>
|
||||
|
||||
<@ macro githubViewLink(doc) -@>
|
||||
<a href="https://github.com/<$ versionInfo.gitRepoInfo.owner $>/<$ versionInfo.gitRepoInfo.repo $>/tree/master/<$ doc.fileInfo.relativePath $>#L<$ doc.location.start.line+1 $>-L<$ doc.location.end.line+1 $>"><$ doc.fileInfo.relativePath $> (line <$ doc.location.start.line+1 $>)</a>
|
||||
<@- endmacro -@>
|
||||
|
||||
<@ macro paramTable(params, isDirective) -@>
|
||||
<table class="table param-table" style="margin:0;">
|
||||
<thead>
|
||||
<tr>
|
||||
<th><@ if isDirective @>Attr<@ else @>Param<@ endif @></th>
|
||||
<th>Type</th>
|
||||
<th>Details</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<@ for param in params @>
|
||||
<tr>
|
||||
<td>
|
||||
<$ param.name $>
|
||||
<@ if param.alias @>| <$ param.alias $><@ endif @>
|
||||
<@ if param.type.optional @><div><em>(optional)</em></div><@ endif @>
|
||||
</td>
|
||||
<td>
|
||||
<$ typeList(param.typeList) $>
|
||||
</td>
|
||||
<td>
|
||||
<$ param.description | marked $>
|
||||
<@ if param.default @><p><em>(default: <$ param.default $>)</em></p><@ endif @>
|
||||
</td>
|
||||
</tr>
|
||||
<@ endfor @>
|
||||
</tbody>
|
||||
</table>
|
||||
<@- endmacro -@>
|
||||
|
||||
<@ macro inputTable(params, isDirective) -@>
|
||||
<table class="table param-table" style="margin:0;">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Attr</th>
|
||||
<th>Type</th>
|
||||
<th>Details</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<@ for param in params @>
|
||||
<tr>
|
||||
<td><$ param.name $></td>
|
||||
<td><code><$ param.type $></code></td>
|
||||
<td><$ param.description | marked $></td>
|
||||
</tr>
|
||||
<@ endfor @>
|
||||
</tbody>
|
||||
</table>
|
||||
<@- endmacro -@>
|
||||
|
||||
<@ macro outputTable(params, isDirective) -@>
|
||||
<table class="table param-table" style="margin:0;">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Attr</th>
|
||||
<th>Details</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<@ for param in params @>
|
||||
<tr>
|
||||
<td><$ param.name $></td>
|
||||
<td><$ param.description | marked $></td>
|
||||
</tr>
|
||||
<@ endfor @>
|
||||
</tbody>
|
||||
</table>
|
||||
<@- endmacro -@>
|
||||
|
||||
<@- macro functionSyntax(fn) @>
|
||||
<@- set sep = joiner(', ') -@>
|
||||
<code><$ fn.name $><@- if not fn.isProperty @>(<@ endif -@><@- for param in fn.params @><$ sep() $>
|
||||
<@- if param.type.optional @>[<@ endif -@>
|
||||
<$ param.name $>
|
||||
<@- if param.type.optional @>]<@ endif -@>
|
||||
<@ endfor @><@- if not fn.isProperty @>)<@ endif -@></code>
|
||||
<@ if fn.alias @><small>(alias: <$ fn.alias $>)</small><@ endif @>
|
||||
<@ endmacro -@>
|
||||
|
||||
<@ macro typeList(types) -@>
|
||||
<@ set separator = joiner("|") @>
|
||||
<@ for type in types @><$ separator() $><$ type | code $><@ endfor @>
|
||||
<@- endmacro -@>
|
||||
|
||||
<@- macro typeInfo(fn) -@>
|
||||
<$ typeList(fn.typeList) $> <$ fn.description | marked $>
|
||||
<@- endmacro -@>
|
||||
|
||||
<@- macro sassTable(files) -@>
|
||||
<div id="sass-variables" ng-controller="SassToggleCtrl">
|
||||
<div class="sass-platform-toggle">
|
||||
<@ if files.length > 1 @>
|
||||
<@ for file in files @>
|
||||
<@ if loop.first @>
|
||||
<a ng-init="setSassPlatform('<$ file.platform $>')" ng-class="{ active: active === '<$ file.platform $>' }" ng-click="setSassPlatform('<$ file.platform $>')" ><$ file.platform | platform $></a>
|
||||
<@ else @>
|
||||
<a ng-class="{ active: active === '<$ file.platform $>' }" ng-click="setSassPlatform('<$ file.platform $>')"><$ file.platform | platform $></a>
|
||||
<@ endif @>
|
||||
<@ endfor @>
|
||||
<@ else @>
|
||||
<h3 ng-init="setSassPlatform('<$ files[0].platform $>')"><$ files[0].platform | platform $></h3>
|
||||
<@ endif @>
|
||||
</div>
|
||||
|
||||
|
||||
<@ for file in files @>
|
||||
<table ng-show="active === '<$ file.platform $>'" id="sass-<$file.platform $>" class="table param-table" style="margin:0;">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Property</th>
|
||||
<th>Default</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<@ for prop in file.props @>
|
||||
<tr>
|
||||
<td><code>$<$ prop.name $></code></td>
|
||||
<@ if prop.default @>
|
||||
<td><$ prop.default | code $></td>
|
||||
<@ else @>
|
||||
<td>
|
||||
|
||||
</td>
|
||||
<@ endif @>
|
||||
<td><$ prop.description | marked $></td>
|
||||
</tr>
|
||||
<@ endfor @>
|
||||
</tbody>
|
||||
</table>
|
||||
<@ endfor @>
|
||||
</div>
|
||||
<@- endmacro -@>
|
||||
|
||||
<@ block body @>
|
||||
|
||||
|
||||
<@ block content @>
|
||||
|
||||
<@ block header @>
|
||||
|
||||
<h1 class="api-title">
|
||||
<a class="anchor" name="<$ doc.name | dashCase $>" href="#<$ doc.name | dashCase $>"></a>
|
||||
<@ if doc.docType == "directive" @>
|
||||
<$ doc.name | dashCase $>
|
||||
<@ else @>
|
||||
<$ doc.name $>
|
||||
<@- if doc.decorators[0].argumentInfo[0].selector @>
|
||||
<h3><code><$ doc.decorators[0].argumentInfo[0].selector $></code></h3>
|
||||
<@ endif -@>
|
||||
<@ endif @>
|
||||
|
||||
<@ if doc.parent @>
|
||||
<br />
|
||||
<small>
|
||||
Child of <$ doc.parent $>
|
||||
</small>
|
||||
<@ endif @>
|
||||
|
||||
<@ if doc.delegate @>
|
||||
<br/>
|
||||
<small>
|
||||
Delegate: <$ doc.delegate $>
|
||||
</small>
|
||||
<@ endif @>
|
||||
|
||||
</h1>
|
||||
|
||||
<a class="improve-v2-docs" href="http://github.com/ionic-team/ionic/edit/master/<$ doc.fileInfo.projectRelativePath $>#L<$ doc.location.start.line $>">
|
||||
Improve this doc
|
||||
</a>
|
||||
|
||||
<@ if doc.codepen @>
|
||||
{% include codepen.html id="<$ doc.codepen $>" %}
|
||||
<@ endif @>
|
||||
|
||||
<@ endblock @>
|
||||
|
||||
<@ block description @>
|
||||
<$ doc.description | marked $>
|
||||
<@ endblock @>
|
||||
|
||||
|
||||
<!-- @usage tag -->
|
||||
<@ if doc.usage @>
|
||||
<h2><a class="anchor" name="usage" href="#usage"></a>Usage</h2>
|
||||
<@ block usage @>
|
||||
<$ doc.usage | marked $>
|
||||
<@ endblock @>
|
||||
<@ endif @>
|
||||
|
||||
<!-- @property tags -->
|
||||
<@ if doc.properties @>
|
||||
<h2><a class="anchor" name="attributes" href="#attributes"></a>Attributes:</h2>
|
||||
<table class="table" style="margin:0;">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Attribute</th>
|
||||
|
||||
<@ set hasTypes = false @>
|
||||
<@ for prop in doc.properties @>
|
||||
<@ if prop.type @>
|
||||
<@ set hasTypes = true @>
|
||||
<@ endif @>
|
||||
<@ endfor @>
|
||||
<@ if hasTypes @>
|
||||
<th>Type</th>
|
||||
<@ endif @>
|
||||
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<@ for prop in doc.properties @>
|
||||
<tr>
|
||||
<td>
|
||||
<$ prop.name $>
|
||||
</td>
|
||||
|
||||
<@ if hasTypes @>
|
||||
<td>
|
||||
<$ prop.type.name $>
|
||||
</td>
|
||||
<@ endif @>
|
||||
|
||||
<td>
|
||||
<$ prop.description $>
|
||||
</td>
|
||||
</tr>
|
||||
<@ endfor @>
|
||||
</tbody>
|
||||
</table>
|
||||
<@ endif @>
|
||||
|
||||
|
||||
<@- if doc.statics.length -@>
|
||||
<h2><a class="anchor" name="static-members" href="#static-members"></a>Static Members</h2>
|
||||
<@- for method in doc.statics @><@ if not method.internal @>
|
||||
<div id="<$ method.name $>"></div>
|
||||
<h3><a class="anchor" name="<$ method.name $>" href="#<$ method.name $>"></a><$ functionSyntax(method) $></h3>
|
||||
|
||||
<$ method.description $>
|
||||
|
||||
<@ if method.params @>
|
||||
<$ paramTable(method.params) $>
|
||||
<@ endif @>
|
||||
|
||||
<@ if method.this @>
|
||||
<h4> Method's `this`
|
||||
<$ method.this $>
|
||||
</h4>
|
||||
<@ endif @>
|
||||
|
||||
<@ if method.returns @>
|
||||
<div class="anchor" class="return-value">
|
||||
<i class="icon ion-arrow-return-left"></i>
|
||||
<b>Returns:</b> <$ typeInfo(method.returns) $>
|
||||
<@ if method.returnsObjectParams @>
|
||||
<$ returnObject(method.returnsObjectParams) $>
|
||||
<@ endif @>
|
||||
</div>
|
||||
<@ endif @>
|
||||
<@ endif @>
|
||||
<@ endfor -@>
|
||||
<@ endif @>
|
||||
|
||||
|
||||
<!-- instance methods on the class -->
|
||||
<@- if doc.members and doc.members.length @>
|
||||
|
||||
<h2><a class="anchor" name="instance-members" href="#instance-members"></a>Instance Members</h2>
|
||||
<@- for method in doc.members @>
|
||||
|
||||
<div id="<$ method.name $>"></div>
|
||||
|
||||
<h3>
|
||||
<a class="anchor" name="<$ method.name $>" href="#<$ method.name $>"></a>
|
||||
<$ functionSyntax(method) $>
|
||||
</h3>
|
||||
|
||||
<$ method.description $>
|
||||
|
||||
<@ if method.params @>
|
||||
<$ paramTable(method.params) $>
|
||||
<@ endif @>
|
||||
|
||||
<@ if method.this @>
|
||||
<h4> Method's `this`
|
||||
<$ method.this $>
|
||||
</h4>
|
||||
<@ endif @>
|
||||
|
||||
<@ if method.returns @>
|
||||
<div class="return-value">
|
||||
<i class="icon ion-arrow-return-left"></i>
|
||||
<b>Returns:</b> <$ typeInfo(method.returns) $>
|
||||
<@ if method.returnsObjectParams @>
|
||||
<$ returnObject(method.returnsObjectParams) $>
|
||||
<@ endif @>
|
||||
</div>
|
||||
<@ endif @>
|
||||
|
||||
<@ endfor -@>
|
||||
|
||||
<@- endif -@>
|
||||
|
||||
|
||||
<@- if doc.inputs and doc.inputs.length @>
|
||||
<!-- input methods on the class -->
|
||||
<h2><a class="anchor" name="input-properties" href="#input-properties"></a>Input Properties</h2>
|
||||
<$ inputTable(doc.inputs) $>
|
||||
<@- endif -@>
|
||||
|
||||
<@- if doc.outputs and doc.outputs.length @>
|
||||
<!-- output events on the class -->
|
||||
<h2><a class="anchor" name="output-events" href="#output-events"></a>Output Events</h2>
|
||||
<$ outputTable(doc.outputs) $>
|
||||
<@- endif -@>
|
||||
|
||||
|
||||
<@ block advanced @>
|
||||
<@- if doc.advanced -@>
|
||||
<h2><a class="anchor" name="advanced" href="#advanced"></a>Advanced</h2>
|
||||
<$ doc.advanced | marked $>
|
||||
<@- endif -@>
|
||||
<@ endblock @>
|
||||
|
||||
<@ if doc.sassVariables @>
|
||||
<h2 id="sass-variable-header"><a class="anchor" name="sass-variables" href="#sass-variables"></a>Sass Variables</h2>
|
||||
<$ sassTable(doc.sassVariables) $>
|
||||
<@ endif @>
|
||||
|
||||
|
||||
<!-- related link -->
|
||||
<@- if doc.see @>
|
||||
|
||||
<h2><a class="anchor" name="related" href="#related"></a>Related</h2>
|
||||
<@ for s in doc.see @>
|
||||
<$ s | safe $> <@- if not loop.last @>,<@- endif -@>
|
||||
<@- endfor -@>
|
||||
|
||||
<@- endif -@>
|
||||
|
||||
|
||||
<!-- end content block -->
|
||||
<@ endblock @>
|
||||
|
||||
<!-- end body block -->
|
||||
<@ endblock @>
|
||||
Reference in New Issue
Block a user