UNPKG

1.62 kBTypeScriptView Raw
1import { CSSSelector } from '../shared';
2import Swiper from '../swiper-class';
3
4export interface NavigationMethods {
5 /**
6 * HTMLElement of "next" navigation button
7 */
8 nextEl: HTMLElement;
9
10 /**
11 * HTMLElement of "previous" navigation button
12 */
13 prevEl: HTMLElement;
14
15 /**
16 * Update navigation buttons state (enabled/disabled)
17 */
18 update(): void;
19}
20
21export interface NavigationEvents {
22 /**
23 * Event will be fired on navigation hide
24 */
25 navigationHide: (swiper: Swiper) => void;
26 /**
27 * Event will be fired on navigation show
28 */
29 navigationShow: (swiper: Swiper) => void;
30}
31
32export interface NavigationOptions {
33 /**
34 * String with CSS selector or HTML element of the element that will work
35 * like "next" button after click on it
36 *
37 * @default null
38 */
39 nextEl?: CSSSelector | HTMLElement;
40
41 /**
42 * String with CSS selector or HTML element of the element that will work
43 * like "prev" button after click on it
44 *
45 * @default null
46 */
47 prevEl?: CSSSelector | HTMLElement;
48
49 /**
50 * Toggle navigation buttons visibility after click on Slider's container
51 *
52 * @default false
53 */
54 hideOnClick?: boolean;
55
56 /**
57 * CSS class name added to navigation button when it becomes disabled
58 *
59 * @default 'swiper-button-disabled'
60 */
61 disabledClass?: string;
62
63 /**
64 * CSS class name added to navigation button when it becomes hidden
65 *
66 * @default 'swiper-button-hidden'
67 */
68 hiddenClass?: string;
69
70 /**
71 * CSS class name added to navigation button when it is disabled
72 *
73 * @default 'swiper-button-lock'
74 */
75 lockClass?: string;
76}