javascript/ionic-framework
1
0
Fork 0
mirror of https://github.com/ionic-team/ionic-framework.git synced 2025-08-22 21:48:42 +08:00
Code Issues Packages Projects Releases Wiki Activity

docs(slides): add params for slide functions (#10972)

Browse Source 
* Update documentation for ion-slide

Reading the documentation and following along left me lost as to why the .lockNextSlides() was not working, this was because it required a boolean parameter that was not reflected in the documentation. This PR adds the JSDoc @param to show that the function requires a boolean parameter. Does not include a definition for the single parameters so this may cause issue in the theme of the docs template.

* Changing order of type definition

* Adding definitions to JSdoc for slider.
This commit is contained in:
James Wilkinson
2017-04-13 16:14:31 -04:00
committed by Brandy Carney
parent bc9accf215
commit 65c250be95
1 changed files with 7 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
src/components/slides/slides.ts
View File

@ -1035,6 +1035,8 @@ export class Slides extends Ion {
/** /**
* Lock or unlock the ability to slide to the next slides. * Lock or unlock the ability to slide to the next slides.
* @param {boolean} shouldLockSwipeToNext If set to true the user will not be able to swipe to the next slide.
* Set to false to unlock this behaviour.
*/ */
lockSwipeToNext(shouldLockSwipeToNext: boolean) { lockSwipeToNext(shouldLockSwipeToNext: boolean) {
this._allowSwipeToNext = !shouldLockSwipeToNext; this._allowSwipeToNext = !shouldLockSwipeToNext;
@ -1042,6 +1044,8 @@ export class Slides extends Ion {
/** /**
* Lock or unlock the ability to slide to the previous slides. * Lock or unlock the ability to slide to the previous slides.
* @param {boolean} shouldLockSwipeToPrev If set to true the user will not be able to swipe to the previous slide.
* Set to false to unlock this behaviour.
*/ */
lockSwipeToPrev(shouldLockSwipeToPrev: boolean) { lockSwipeToPrev(shouldLockSwipeToPrev: boolean) {
this._allowSwipeToPrev = !shouldLockSwipeToPrev; this._allowSwipeToPrev = !shouldLockSwipeToPrev;
@ -1049,6 +1053,8 @@ export class Slides extends Ion {
/** /**
* Lock or unlock the ability to slide to change slides. * Lock or unlock the ability to slide to change slides.
* @param {boolean} shouldLockSwipes If set to true user can not swipe in either direction on slide.
* False allows swiping in both directions.
*/ */
lockSwipes(shouldLockSwipes: boolean) { lockSwipes(shouldLockSwipes: boolean) {
this._allowSwipeToNext = this._allowSwipeToPrev = !shouldLockSwipes; this._allowSwipeToNext = this._allowSwipeToPrev = !shouldLockSwipes;
@ -1056,6 +1062,7 @@ export class Slides extends Ion {
/** /**
* Enable or disable keyboard control. * Enable or disable keyboard control.
* @param {boolean} shouldEnableKeyboard If set to true the slider can be controled by a keyboard.
*/ */
enableKeyboardControl(shouldEnableKeyboard: boolean) { enableKeyboardControl(shouldEnableKeyboard: boolean) {
enableKeyboardControl(this, this._plt, shouldEnableKeyboard); enableKeyboardControl(this, this._plt, shouldEnableKeyboard);