feat(swiper): expose full API (#19137)

* expose full swiper API * update types * run build * run angular build
ionic-team · Aug 27, 2019 · e1fa461 · e1fa461
1 parent 0e18f04
commit e1fa461
Show file tree

Hide file tree

Showing 5 changed files with 28 additions and 5 deletions.
diff --git a/angular/src/directives/proxies.ts b/angular/src/directives/proxies.ts
@@ -807,7 +807,7 @@ export class IonSlides {
     proxyOutputs(this, this.el, ['ionSlidesDidLoad', 'ionSlideTap', 'ionSlideDoubleTap', 'ionSlideWillChange', 'ionSlideDidChange', 'ionSlideNextStart', 'ionSlidePrevStart', 'ionSlideNextEnd', 'ionSlidePrevEnd', 'ionSlideTransitionStart', 'ionSlideTransitionEnd', 'ionSlideDrag', 'ionSlideReachStart', 'ionSlideReachEnd', 'ionSlideTouchStart', 'ionSlideTouchEnd']);
   }
 }
-proxyMethods(IonSlides, ['update', 'updateAutoHeight', 'slideTo', 'slideNext', 'slidePrev', 'getActiveIndex', 'getPreviousIndex', 'length', 'isEnd', 'isBeginning', 'startAutoplay', 'stopAutoplay', 'lockSwipeToNext', 'lockSwipeToPrev', 'lockSwipes']);
+proxyMethods(IonSlides, ['update', 'updateAutoHeight', 'slideTo', 'slideNext', 'slidePrev', 'getActiveIndex', 'getPreviousIndex', 'length', 'isEnd', 'isBeginning', 'startAutoplay', 'stopAutoplay', 'lockSwipeToNext', 'lockSwipeToPrev', 'lockSwipes', 'getSwiper']);
 proxyInputs(IonSlides, ['mode', 'options', 'pager', 'scrollbar']);
 
 export declare interface IonSpinner extends Components.IonSpinner {}

diff --git a/core/api.txt b/core/api.txt
@@ -1068,6 +1068,7 @@ ion-slides,prop,pager,boolean,false,false,false
 ion-slides,prop,scrollbar,boolean,false,false,false
 ion-slides,method,getActiveIndex,getActiveIndex() => Promise<number>
 ion-slides,method,getPreviousIndex,getPreviousIndex() => Promise<number>
+ion-slides,method,getSwiper,getSwiper() => Promise<any>
 ion-slides,method,isBeginning,isBeginning() => Promise<boolean>
 ion-slides,method,isEnd,isEnd() => Promise<boolean>
 ion-slides,method,length,length() => Promise<number>

diff --git a/core/src/components.d.ts b/core/src/components.d.ts
@@ -2388,6 +2388,10 @@ export namespace Components {
     */
     'getPreviousIndex': () => Promise<number>;
     /**
+    * Get the Swiper instance. Use this to access the full Swiper API. See https://idangero.us/swiper/api/ for all API options.
+    */
+    'getSwiper': () => Promise<any>;
+    /**
     * Get whether or not the current slide is the first slide.
     */
     'isBeginning': () => Promise<boolean>;

diff --git a/core/src/components/slides/readme.md b/core/src/components/slides/readme.md
@@ -614,6 +614,18 @@ Type: `Promise<number>`
 
 
 
+### `getSwiper() => Promise<any>`
+
+Get the Swiper instance.
+Use this to access the full Swiper API.
+See https://idangero.us/swiper/api/ for all API options.
+
+#### Returns
+
+Type: `Promise<any>`
+
+
+
 ### `isBeginning() => Promise<boolean>`
 
 Get whether or not the current slide is the first slide.

diff --git a/core/src/components/slides/slides.tsx b/core/src/components/slides/slides.tsx
@@ -320,6 +320,16 @@ export class Slides implements ComponentInterface {
     swiper.allowTouchMove = !lock;
   }
 
+  /**
+   * Get the Swiper instance.
+   * Use this to access the full Swiper API.
+   * See https://idangero.us/swiper/api/ for all API options.
+   */
+  @Method()
+  async getSwiper(): Promise<any> {
+    return this.swiper;
+  }
+
   private async initSwiper() {
     const finalOptions = this.normalizeOptions();
 
@@ -332,10 +342,6 @@ export class Slides implements ComponentInterface {
     this.readySwiper(swiper);
   }
 
-  private getSwiper() {
-    return this.swiper;
-  }
-
   private normalizeOptions(): SwiperOptions {
     // Base options, can be changed
     // TODO Add interface SwiperOptions