docs(): add missing property docs

This commit is contained in:
mhartington
2018-06-18 15:23:26 -04:00
parent 79ebbd0cba
commit 503636ada8
8 changed files with 33 additions and 27 deletions

View File

@ -1,5 +1,6 @@
# ion-route-link # ion-anchor
Anchor is a component used for navigating to a specified link. Similar to the browsers anchor tag, Anchor can accept a href for the location, and a direction for the transition animation.
<!-- Auto Generated Below --> <!-- Auto Generated Below -->

View File

@ -80,6 +80,9 @@ export class Content {
return this.scrollEl.scrollToBottom(duration); return this.scrollEl.scrollToBottom(duration);
} }
/**
* Scroll by a specific X/Y distance
*/
@Method() @Method()
scrollByPoint(x: number, y: number, duration: number, done?: Function): Promise<any> { scrollByPoint(x: number, y: number, duration: number, done?: Function): Promise<any> {
if (!this.scrollEl) { if (!this.scrollEl) {
@ -88,6 +91,9 @@ export class Content {
return this.scrollEl.scrollByPoint(x, y, duration, done); return this.scrollEl.scrollByPoint(x, y, duration, done);
} }
/**
* Scroll to a specific X/Y coordinate in the content
*/
@Method() @Method()
scrollToPoint(x: number, y: number, duration: number, done?: Function): Promise<any> { scrollToPoint(x: number, y: number, duration: number, done?: Function): Promise<any> {
if (!this.scrollEl) { if (!this.scrollEl) {

View File

@ -46,6 +46,9 @@ export class FabButton {
*/ */
@Prop() translucent = false; @Prop() translucent = false;
/**
* If true, the fab button will show when in a fab-list.
*/
@Prop() show = false; @Prop() show = false;
componentWillLoad() { componentWillLoad() {

View File

@ -29,6 +29,7 @@ export class Img {
this.addIO(); this.addIO();
} }
/** Emitted when the img src is loaded */
@Event() ionImgDidLoad!: EventEmitter<void>; @Event() ionImgDidLoad!: EventEmitter<void>;
componentDidLoad() { componentDidLoad() {

View File

@ -1,5 +1,6 @@
# ion-input # ion-input
Input is a component similar to the HTML input element. It accepts most of the standard properties/attributes as the HTML input, but is styled to fit Ionic's UI.
<!-- Auto Generated Below --> <!-- Auto Generated Below -->

View File

@ -32,6 +32,8 @@ export class Loading implements OverlayInterface {
@Prop({ connect: 'ion-animation-controller' }) animationCtrl!: HTMLIonAnimationControllerElement; @Prop({ connect: 'ion-animation-controller' }) animationCtrl!: HTMLIonAnimationControllerElement;
@Prop({ context: 'config' }) config!: Config; @Prop({ context: 'config' }) config!: Config;
@Prop() overlayId!: number; @Prop() overlayId!: number;
/** If true, the loading will blur any inputs and hide the keyboard */
@Prop() keyboardClose = true; @Prop() keyboardClose = true;
/** /**

View File

@ -50,20 +50,15 @@ export class Menu {
@State() isEndSide = false; @State() isEndSide = false;
@Prop({ context: 'config' }) @Prop({ context: 'config' }) config!: Config;
config!: Config;
@Prop({ context: 'isServer' }) @Prop({ context: 'isServer' }) isServer!: boolean;
isServer!: boolean;
@Prop({ connect: 'ion-menu-controller' }) @Prop({ connect: 'ion-menu-controller' }) lazyMenuCtrl!: HTMLIonMenuControllerElement;
lazyMenuCtrl!: HTMLIonMenuControllerElement;
@Prop({ context: 'enableListener' }) @Prop({ context: 'enableListener' }) enableListener!: EventListenerEnable;
enableListener!: EventListenerEnable;
@Prop({ context: 'window' }) @Prop({ context: 'window' }) win!: Window;
win!: Window;
/** /**
* The content's id the menu should use. * The content's id the menu should use.
@ -79,8 +74,7 @@ export class Menu {
* The display type of the menu. * The display type of the menu.
* Available options: `"overlay"`, `"reveal"`, `"push"`. * Available options: `"overlay"`, `"reveal"`, `"push"`.
*/ */
@Prop({ mutable: true }) @Prop({ mutable: true }) type!: string;
type!: string;
@Watch('type') @Watch('type')
typeChanged(type: string, oldType: string | null) { typeChanged(type: string, oldType: string | null) {
@ -100,8 +94,7 @@ export class Menu {
/** /**
* If true, the menu is disabled. Default `false`. * If true, the menu is disabled. Default `false`.
*/ */
@Prop({ mutable: true }) @Prop({ mutable: true }) disabled = false;
disabled = false;
@Watch('disabled') @Watch('disabled')
protected disabledChanged(disabled: boolean) { protected disabledChanged(disabled: boolean) {
@ -150,6 +143,9 @@ export class Menu {
*/ */
@Event() ionClose!: EventEmitter<void>; @Event() ionClose!: EventEmitter<void>;
/**
* Emitted when the menu state is changed.
*/
@Event() protected ionMenuChange!: EventEmitter<MenuChangeEventDetail>; @Event() protected ionMenuChange!: EventEmitter<MenuChangeEventDetail>;
async componentWillLoad() { async componentWillLoad() {

View File

@ -55,27 +55,23 @@ export class Nav implements NavOutlet {
@Element() el!: HTMLElement; @Element() el!: HTMLElement;
@Prop({ context: 'queue' }) @Prop({ context: 'queue' }) queue!: QueueController;
queue!: QueueController;
@Prop({ context: 'config' }) @Prop({ context: 'config' }) config!: Config;
config!: Config;
@Prop({ context: 'window' }) @Prop({ context: 'window' }) win!: Window;
win!: Window;
@Prop({ connect: 'ion-animation-controller' }) animationCtrl!: HTMLIonAnimationControllerElement;
@Prop({ connect: 'ion-animation-controller' })
animationCtrl!: HTMLIonAnimationControllerElement;
/** /**
* If the nav component should allow for swipe-to-go-back * If the nav component should allow for swipe-to-go-back
*/ */
@Prop({ mutable: true }) @Prop({ mutable: true }) swipeBackEnabled?: boolean;
swipeBackEnabled?: boolean;
/** /**
* If the nav should animate the components or not * If the nav should animate the components or not
*/ */
@Prop({ mutable: true }) @Prop({ mutable: true }) animated?: boolean;
animated?: boolean;
/** @hidden */ /** @hidden */
@Prop() delegate?: FrameworkDelegate; @Prop() delegate?: FrameworkDelegate;