UNPKG

2.02 kBTypeScriptView Raw
1export interface A11yMethods {}
2
3export interface A11yEvents {}
4
5export interface A11yOptions {
6 /**
7 * Enables A11y
8 *
9 * @default true
10 */
11 enabled?: boolean;
12
13 /**
14 * Message for screen readers for previous button
15 *
16 * @default 'Previous slide'
17 */
18 prevSlideMessage?: string;
19
20 /**
21 * Message for screen readers for next button
22 *
23 * @default 'Next slide'
24 */
25 nextSlideMessage?: string;
26
27 /**
28 * Message for screen readers for previous button when swiper is on first slide
29 *
30 * @default 'This is the first slide'
31 */
32 firstSlideMessage?: string;
33
34 /**
35 * Message for screen readers for next button when swiper is on last slide
36 *
37 * @default 'This is the last slide'
38 */
39 lastSlideMessage?: string;
40
41 /**
42 * Message for screen readers for single pagination bullet
43 *
44 * @default 'Go to slide {{index}}'
45 */
46 paginationBulletMessage?: string;
47
48 /**
49 * CSS class name of A11y notification
50 *
51 * @default 'swiper-notification'
52 */
53 notificationClass?: string;
54
55 /**
56 * Message for screen readers for outer swiper container
57 *
58 * @default null
59 */
60 containerMessage?: string | null;
61
62 /**
63 * Message for screen readers describing the role of outer swiper container
64 *
65 * @default null
66 */
67 containerRoleDescriptionMessage?: string | null;
68
69 /**
70 * Message for screen readers describing the role of slide element
71 *
72 * @default null
73 */
74 itemRoleDescriptionMessage?: string | null;
75
76 /**
77 * Message for screen readers describing the label of slide element
78 *
79 * @default '{{index}} / {{slidesLength}}'
80 */
81 slideLabelMessage?: string;
82
83 /**
84 * Value of swiper slide `role` attribute
85 *
86 * @default 'group'
87 */
88 slideRole?: string;
89
90 /**
91 * Value of `id` attribute to be set on swiper-wrapper. If `null` will be generated automatically
92 *
93 * @default null
94 */
95 id?: string | number | null;
96}