Skip to content

Commit bc61bce

Browse files
authored
fix(types): fixed SwiperModule, slideTo, effectInit types (#7428)
* fix(types): fixed SwiperModule, slideTo, effectInit types * fix(types): Update shared.d.ts
1 parent ced97a2 commit bc61bce

File tree

3 files changed

+22
-14
lines changed

3 files changed

+22
-14
lines changed

src/swiper-effect-utils.d.ts

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,13 +5,13 @@ declare const createShadow: (suffix?: string, slideEl: HTMLElement, side?: strin
55
declare const effectInit: (params: {
66
effect: string;
77
swiper: Swiper;
8-
on?: () => void;
9-
setTranslate?: () => void;
10-
setTransition?: () => void;
8+
on: () => void;
9+
setTranslate: () => void;
10+
setTransition: (duration: number) => void;
1111
overwriteParams?: () => SwiperOptions;
12-
perspective?: boolean;
12+
perspective?: () => boolean;
1313
recreateShadows?: () => void;
14-
getEffectParams?: () => any;
14+
getEffectParams?: () => { slideShadows?: boolean };
1515
}) => void;
1616

1717
declare const effectTarget: (effectParams: any, slideEl: HTMLElement) => void;

src/types/shared.d.ts

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,13 @@
1+
import { Swiper } from './index.d.ts';
2+
13
export interface CSSSelector extends String {}
24

3-
export interface SwiperModule {
4-
name: string;
5-
}
5+
export type SwiperModule = (options: {
6+
params: Swiper['params'];
7+
swiper: Swiper;
8+
extendParams: (obj: { [name: string]: any }) => void;
9+
on: Swiper['on'];
10+
once: Swiper['once'];
11+
off: Swiper['off'];
12+
emit: Swiper['emit'];
13+
}) => void;

src/types/swiper-class.d.ts

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -215,7 +215,7 @@ interface Swiper extends SwiperClass<SwiperEvents> {
215215
* @param runCallbacks Set it to false (by default it is true) and transition will
216216
* not produce transition events.
217217
*/
218-
slideNext(speed?: number, runCallbacks?: boolean): void;
218+
slideNext(speed?: number, runCallbacks?: boolean): boolean;
219219

220220
/**
221221
* Run transition to previous slide.
@@ -224,7 +224,7 @@ interface Swiper extends SwiperClass<SwiperEvents> {
224224
* @param runCallbacks Set it to false (by default it is true) and transition will
225225
* not produce transition events.
226226
*/
227-
slidePrev(speed?: number, runCallbacks?: boolean): void;
227+
slidePrev(speed?: number, runCallbacks?: boolean): boolean;
228228

229229
/**
230230
* Run transition to the slide with index number equal to 'index' parameter for the
@@ -235,7 +235,7 @@ interface Swiper extends SwiperClass<SwiperEvents> {
235235
* @param runCallbacks Set it to false (by default it is true) and transition will
236236
* not produce transition events.
237237
*/
238-
slideTo(index: number, speed?: number, runCallbacks?: boolean): void;
238+
slideTo(index: number, speed?: number, runCallbacks?: boolean): boolean;
239239

240240
/**
241241
* Does the same as .slideTo but for the case when used with enabled loop. So this
@@ -246,7 +246,7 @@ interface Swiper extends SwiperClass<SwiperEvents> {
246246
* @param runCallbacks Set it to false (by default it is true) and transition will
247247
* not produce transition events.
248248
*/
249-
slideToLoop(index: number, speed?: number, runCallbacks?: boolean): void;
249+
slideToLoop(index: number, speed?: number, runCallbacks?: boolean): Swiper;
250250

251251
/**
252252
* Reset swiper position to currently active slide for the duration equal to 'speed'
@@ -256,7 +256,7 @@ interface Swiper extends SwiperClass<SwiperEvents> {
256256
* @param runCallbacks Set it to false (by default it is true) and transition will
257257
* not produce transition events.
258258
*/
259-
slideReset(speed?: number, runCallbacks?: boolean): void;
259+
slideReset(speed?: number, runCallbacks?: boolean): boolean;
260260

261261
/**
262262
* Reset swiper position to closest slide/snap point for the duration equal to 'speed' parameter.
@@ -265,7 +265,7 @@ interface Swiper extends SwiperClass<SwiperEvents> {
265265
* @param runCallbacks Set it to false (by default it is true) and transition will
266266
* not produce transition events.
267267
*/
268-
slideToClosest(speed?: number, runCallbacks?: boolean): void;
268+
slideToClosest(speed?: number, runCallbacks?: boolean): boolean;
269269

270270
/**
271271
* Get dynamically calculated amount of slides per view, useful only when slidesPerView set to `auto`

0 commit comments

Comments
 (0)