Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(components): update method and parameter descriptions #18075

Merged
merged 26 commits into from
Apr 23, 2019
Merged

docs(components): update method and parameter descriptions #18075

Show file tree
Hide file tree
Changes from 19 commits
Commits
Show all changes
26 commits
Select commit Hold shift + click to select a range
feda138
docs(nav): add method parameter descriptions
brandyscarney Apr 18, 2019
d42d12e
docs(picker): add method parameter descriptions
brandyscarney Apr 18, 2019
76a5e86
docs(popover): add method parameter descriptions
brandyscarney Apr 18, 2019
0549fea
docs(virtual-scroll): add method parameter descriptions
brandyscarney Apr 18, 2019
7cb9f1b
docs(toast): add method parameter descriptions
brandyscarney Apr 18, 2019
af9e953
docs(action-sheet): add method parameter descriptions
brandyscarney Apr 18, 2019
503f010
docs(alert): add method parameter descriptions
brandyscarney Apr 18, 2019
a852e82
docs(content): add method parameter descriptions
brandyscarney Apr 18, 2019
caec8e2
docs(fab): add missing period to method description
brandyscarney Apr 18, 2019
735e299
docs(loading): add method parameter descriptions
brandyscarney Apr 18, 2019
7cc5de1
docs(menu): add and update method descriptions
brandyscarney Apr 18, 2019
0b2fa44
docs(modal): add method parameter descriptions
brandyscarney Apr 18, 2019
646a823
docs(router): add method parameter descriptions
brandyscarney Apr 18, 2019
1548796
docs(select): add method parameter descriptions
brandyscarney Apr 18, 2019
6ed79cd
docs(slides): add method parameter descriptions
brandyscarney Apr 18, 2019
56102b3
docs(tabs): add method parameter descriptions
brandyscarney Apr 18, 2019
ed545c8
docs(ripple-effect): add method parameter descriptions
brandyscarney Apr 18, 2019
17db330
chore(build): the build files from the docs updates
brandyscarney Apr 18, 2019
2d24ca1
docs(components): remove the code samples in descriptions
brandyscarney Apr 18, 2019
d03723a
Merge branch 'master' into docs-parameter-descriptions
liamdebeasi Apr 22, 2019
c3636b3
Merge branch 'master' into docs-parameter-descriptions
brandyscarney Apr 22, 2019
b39a119
docs(components): update default param values
brandyscarney Apr 22, 2019
9f6c25f
docs(menu-controller): update documentation
brandyscarney Apr 23, 2019
8baca6d
docs(menu-controller): rename the menuId param to include side
brandyscarney Apr 23, 2019
c8eb782
docs(slides): update transition events
brandyscarney Apr 23, 2019
550aaef
docs(overlays): update role to include more info on what it does
brandyscarney Apr 23, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 15 additions & 15 deletions core/api.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@

ion-action-sheet-controller,none
ion-action-sheet-controller,method,create,create(opts: ActionSheetOptions) => Promise<HTMLIonActionSheetElement>
ion-action-sheet-controller,method,create,create(options: ActionSheetOptions) => Promise<HTMLIonActionSheetElement>
ion-action-sheet-controller,method,dismiss,dismiss(data?: any, role?: string | undefined, id?: string | undefined) => Promise<boolean>
ion-action-sheet-controller,method,getTop,getTop() => Promise<HTMLIonActionSheetElement | undefined>

Expand Down Expand Up @@ -36,7 +36,7 @@ ion-action-sheet,css-prop,--min-width
ion-action-sheet,css-prop,--width

ion-alert-controller,none
ion-alert-controller,method,create,create(opts: AlertOptions) => Promise<HTMLIonAlertElement>
ion-alert-controller,method,create,create(options: AlertOptions) => Promise<HTMLIonAlertElement>
ion-alert-controller,method,dismiss,dismiss(data?: any, role?: string | undefined, id?: string | undefined) => Promise<boolean>
ion-alert-controller,method,getTop,getTop() => Promise<HTMLIonAlertElement | undefined>

Expand Down Expand Up @@ -532,7 +532,7 @@ ion-list,prop,mode,"ios" | "md",undefined,false,false
ion-list,method,closeSlidingItems,closeSlidingItems() => Promise<boolean>

ion-loading-controller,none
ion-loading-controller,method,create,create(opts?: LoadingOptions | undefined) => Promise<HTMLIonLoadingElement>
ion-loading-controller,method,create,create(options?: LoadingOptions | undefined) => Promise<HTMLIonLoadingElement>
ion-loading-controller,method,dismiss,dismiss(data?: any, role?: string | undefined, id?: string | undefined) => Promise<boolean>
ion-loading-controller,method,getTop,getTop() => Promise<HTMLIonLoadingElement | undefined>

Expand Down Expand Up @@ -575,7 +575,7 @@ ion-menu-button,css-prop,--color

ion-menu-controller,none
ion-menu-controller,method,close,close(menuId?: string | null | undefined) => Promise<boolean>
ion-menu-controller,method,enable,enable(shouldEnable: boolean, menuId?: string | null | undefined) => Promise<HTMLIonMenuElement | undefined>
ion-menu-controller,method,enable,enable(enable: boolean, menuId?: string | null | undefined) => Promise<HTMLIonMenuElement | undefined>
ion-menu-controller,method,get,get(menuId?: string | null | undefined) => Promise<HTMLIonMenuElement | undefined>
ion-menu-controller,method,getMenus,getMenus() => Promise<HTMLIonMenuElement[]>
ion-menu-controller,method,getOpen,getOpen() => Promise<HTMLIonMenuElement | undefined>
Expand All @@ -584,7 +584,7 @@ ion-menu-controller,method,isEnabled,isEnabled(menuId?: string | null | undefine
ion-menu-controller,method,isOpen,isOpen(menuId?: string | null | undefined) => Promise<boolean>
ion-menu-controller,method,open,open(menuId?: string | null | undefined) => Promise<boolean>
ion-menu-controller,method,registerAnimation,registerAnimation(name: string, animation: AnimationBuilder) => void
ion-menu-controller,method,swipeGesture,swipeGesture(shouldEnable: boolean, menuId?: string | null | undefined) => Promise<HTMLIonMenuElement | undefined>
ion-menu-controller,method,swipeGesture,swipeGesture(enable: boolean, menuId?: string | null | undefined) => Promise<HTMLIonMenuElement | undefined>
ion-menu-controller,method,toggle,toggle(menuId?: string | null | undefined) => Promise<boolean>

ion-menu-toggle,shadow
Expand Down Expand Up @@ -618,7 +618,7 @@ ion-menu,css-prop,--min-width
ion-menu,css-prop,--width

ion-modal-controller,none
ion-modal-controller,method,create,create<T extends ComponentRef>(opts: ModalOptions<T>) => Promise<HTMLIonModalElement>
ion-modal-controller,method,create,create<T extends ComponentRef>(options: ModalOptions<T>) => Promise<HTMLIonModalElement>
ion-modal-controller,method,dismiss,dismiss(data?: any, role?: string | undefined, id?: string | undefined) => Promise<boolean>
ion-modal-controller,method,getTop,getTop() => Promise<HTMLIonModalElement | undefined>

Expand Down Expand Up @@ -691,7 +691,7 @@ ion-note,prop,mode,"ios" | "md",undefined,false,false
ion-note,css-prop,--color

ion-picker-controller,none
ion-picker-controller,method,create,create(opts: PickerOptions) => Promise<HTMLIonPickerElement>
ion-picker-controller,method,create,create(options: PickerOptions) => Promise<HTMLIonPickerElement>
ion-picker-controller,method,dismiss,dismiss(data?: any, role?: string | undefined, id?: string | undefined) => Promise<boolean>
ion-picker-controller,method,getTop,getTop() => Promise<HTMLIonPickerElement | undefined>

Expand Down Expand Up @@ -730,7 +730,7 @@ ion-picker,css-prop,--min-width
ion-picker,css-prop,--width

ion-popover-controller,none
ion-popover-controller,method,create,create<T extends ComponentRef>(opts: PopoverOptions<T>) => Promise<HTMLIonPopoverElement>
ion-popover-controller,method,create,create<T extends ComponentRef>(options: PopoverOptions<T>) => Promise<HTMLIonPopoverElement>
ion-popover-controller,method,dismiss,dismiss(data?: any, role?: string | undefined, id?: string | undefined) => Promise<boolean>
ion-popover-controller,method,getTop,getTop() => Promise<HTMLIonPopoverElement | undefined>

Expand Down Expand Up @@ -849,7 +849,7 @@ ion-reorder,shadow

ion-ripple-effect,shadow
ion-ripple-effect,prop,type,"bounded" | "unbounded",'bounded',false,false
ion-ripple-effect,method,addRipple,addRipple(pageX: number, pageY: number) => Promise<() => void>
ion-ripple-effect,method,addRipple,addRipple(x: number, y: number) => Promise<() => void>

ion-route-redirect,none
ion-route-redirect,prop,from,string,undefined,true,false
Expand Down Expand Up @@ -969,7 +969,7 @@ ion-select,prop,okText,string,'OK',false,false
ion-select,prop,placeholder,null | string | undefined,undefined,false,false
ion-select,prop,selectedText,null | string | undefined,undefined,false,false
ion-select,prop,value,any,undefined,false,false
ion-select,method,open,open(ev?: UIEvent | undefined) => Promise<HTMLIonActionSheetElement | HTMLIonAlertElement | HTMLIonPopoverElement | undefined>
ion-select,method,open,open(event?: UIEvent | undefined) => Promise<HTMLIonActionSheetElement | HTMLIonAlertElement | HTMLIonPopoverElement | undefined>
ion-select,event,ionBlur,void,true
ion-select,event,ionCancel,void,true
ion-select,event,ionChange,SelectChangeEventDetail,true
Expand Down Expand Up @@ -998,9 +998,9 @@ ion-slides,method,getPreviousIndex,getPreviousIndex() => Promise<number>
ion-slides,method,isBeginning,isBeginning() => Promise<boolean>
ion-slides,method,isEnd,isEnd() => Promise<boolean>
ion-slides,method,length,length() => Promise<number>
ion-slides,method,lockSwipeToNext,lockSwipeToNext(shouldLockSwipeToNext: boolean) => Promise<void>
ion-slides,method,lockSwipeToPrev,lockSwipeToPrev(shouldLockSwipeToPrev: boolean) => Promise<void>
ion-slides,method,lockSwipes,lockSwipes(shouldLockSwipes: boolean) => Promise<void>
ion-slides,method,lockSwipeToNext,lockSwipeToNext(lock: boolean) => Promise<void>
ion-slides,method,lockSwipeToPrev,lockSwipeToPrev(lock: boolean) => Promise<void>
ion-slides,method,lockSwipes,lockSwipes(lock: boolean) => Promise<void>
ion-slides,method,slideNext,slideNext(speed?: number | undefined, runCallbacks?: boolean | undefined) => Promise<void>
ion-slides,method,slidePrev,slidePrev(speed?: number | undefined, runCallbacks?: boolean | undefined) => Promise<void>
ion-slides,method,slideTo,slideTo(index: number, speed?: number | undefined, runCallbacks?: boolean | undefined) => Promise<void>
Expand Down Expand Up @@ -1129,7 +1129,7 @@ ion-title,prop,color,string | undefined,undefined,false,false
ion-title,css-prop,--color

ion-toast-controller,none
ion-toast-controller,method,create,create(opts?: ToastOptions | undefined) => Promise<HTMLIonToastElement>
ion-toast-controller,method,create,create(options?: ToastOptions | undefined) => Promise<HTMLIonToastElement>
ion-toast-controller,method,dismiss,dismiss(data?: any, role?: string | undefined, id?: string | undefined) => Promise<boolean>
ion-toast-controller,method,getTop,getTop() => Promise<HTMLIonToastElement | undefined>

Expand Down Expand Up @@ -1217,5 +1217,5 @@ ion-virtual-scroll,prop,renderFooter,((item: any, index: number) => any) | undef
ion-virtual-scroll,prop,renderHeader,((item: any, index: number) => any) | undefined,undefined,false,false
ion-virtual-scroll,prop,renderItem,((item: any, index: number) => any) | undefined,undefined,false,false
ion-virtual-scroll,method,checkEnd,checkEnd() => void
ion-virtual-scroll,method,checkRange,checkRange(offset: number, len?: number) => void
ion-virtual-scroll,method,checkRange,checkRange(offset: number, length?: number) => void
ion-virtual-scroll,method,positionForItem,positionForItem(index: number) => Promise<number>
Loading