a11y.js 8.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309
  1. import classesToSelector from '../../shared/classes-to-selector.js';
  2. import $ from '../../shared/dom.js';
  3. export default function A11y(_ref) {
  4. let {
  5. swiper,
  6. extendParams,
  7. on
  8. } = _ref;
  9. extendParams({
  10. a11y: {
  11. enabled: true,
  12. notificationClass: 'swiper-notification',
  13. prevSlideMessage: 'Previous slide',
  14. nextSlideMessage: 'Next slide',
  15. firstSlideMessage: 'This is the first slide',
  16. lastSlideMessage: 'This is the last slide',
  17. paginationBulletMessage: 'Go to slide {{index}}',
  18. slideLabelMessage: '{{index}} / {{slidesLength}}',
  19. containerMessage: null,
  20. containerRoleDescriptionMessage: null,
  21. itemRoleDescriptionMessage: null,
  22. slideRole: 'group'
  23. }
  24. });
  25. let liveRegion = null;
  26. function notify(message) {
  27. const notification = liveRegion;
  28. if (notification.length === 0) return;
  29. notification.html('');
  30. notification.html(message);
  31. }
  32. function getRandomNumber(size) {
  33. if (size === void 0) {
  34. size = 16;
  35. }
  36. const randomChar = () => Math.round(16 * Math.random()).toString(16);
  37. return 'x'.repeat(size).replace(/x/g, randomChar);
  38. }
  39. function makeElFocusable($el) {
  40. $el.attr('tabIndex', '0');
  41. }
  42. function makeElNotFocusable($el) {
  43. $el.attr('tabIndex', '-1');
  44. }
  45. function addElRole($el, role) {
  46. $el.attr('role', role);
  47. }
  48. function addElRoleDescription($el, description) {
  49. $el.attr('aria-roledescription', description);
  50. }
  51. function addElControls($el, controls) {
  52. $el.attr('aria-controls', controls);
  53. }
  54. function addElLabel($el, label) {
  55. $el.attr('aria-label', label);
  56. }
  57. function addElId($el, id) {
  58. $el.attr('id', id);
  59. }
  60. function addElLive($el, live) {
  61. $el.attr('aria-live', live);
  62. }
  63. function disableEl($el) {
  64. $el.attr('aria-disabled', true);
  65. }
  66. function enableEl($el) {
  67. $el.attr('aria-disabled', false);
  68. }
  69. function onEnterOrSpaceKey(e) {
  70. if (e.keyCode !== 13 && e.keyCode !== 32) return;
  71. const params = swiper.params.a11y;
  72. const $targetEl = $(e.target);
  73. if (swiper.navigation && swiper.navigation.$nextEl && $targetEl.is(swiper.navigation.$nextEl)) {
  74. if (!(swiper.isEnd && !swiper.params.loop)) {
  75. swiper.slideNext();
  76. }
  77. if (swiper.isEnd) {
  78. notify(params.lastSlideMessage);
  79. } else {
  80. notify(params.nextSlideMessage);
  81. }
  82. }
  83. if (swiper.navigation && swiper.navigation.$prevEl && $targetEl.is(swiper.navigation.$prevEl)) {
  84. if (!(swiper.isBeginning && !swiper.params.loop)) {
  85. swiper.slidePrev();
  86. }
  87. if (swiper.isBeginning) {
  88. notify(params.firstSlideMessage);
  89. } else {
  90. notify(params.prevSlideMessage);
  91. }
  92. }
  93. if (swiper.pagination && $targetEl.is(classesToSelector(swiper.params.pagination.bulletClass))) {
  94. $targetEl[0].click();
  95. }
  96. }
  97. function updateNavigation() {
  98. if (swiper.params.loop || swiper.params.rewind || !swiper.navigation) return;
  99. const {
  100. $nextEl,
  101. $prevEl
  102. } = swiper.navigation;
  103. if ($prevEl && $prevEl.length > 0) {
  104. if (swiper.isBeginning) {
  105. disableEl($prevEl);
  106. makeElNotFocusable($prevEl);
  107. } else {
  108. enableEl($prevEl);
  109. makeElFocusable($prevEl);
  110. }
  111. }
  112. if ($nextEl && $nextEl.length > 0) {
  113. if (swiper.isEnd) {
  114. disableEl($nextEl);
  115. makeElNotFocusable($nextEl);
  116. } else {
  117. enableEl($nextEl);
  118. makeElFocusable($nextEl);
  119. }
  120. }
  121. }
  122. function hasPagination() {
  123. return swiper.pagination && swiper.pagination.bullets && swiper.pagination.bullets.length;
  124. }
  125. function hasClickablePagination() {
  126. return hasPagination() && swiper.params.pagination.clickable;
  127. }
  128. function updatePagination() {
  129. const params = swiper.params.a11y;
  130. if (!hasPagination()) return;
  131. swiper.pagination.bullets.each(bulletEl => {
  132. const $bulletEl = $(bulletEl);
  133. if (swiper.params.pagination.clickable) {
  134. makeElFocusable($bulletEl);
  135. if (!swiper.params.pagination.renderBullet) {
  136. addElRole($bulletEl, 'button');
  137. addElLabel($bulletEl, params.paginationBulletMessage.replace(/\{\{index\}\}/, $bulletEl.index() + 1));
  138. }
  139. }
  140. if ($bulletEl.is(`.${swiper.params.pagination.bulletActiveClass}`)) {
  141. $bulletEl.attr('aria-current', 'true');
  142. } else {
  143. $bulletEl.removeAttr('aria-current');
  144. }
  145. });
  146. }
  147. const initNavEl = ($el, wrapperId, message) => {
  148. makeElFocusable($el);
  149. if ($el[0].tagName !== 'BUTTON') {
  150. addElRole($el, 'button');
  151. $el.on('keydown', onEnterOrSpaceKey);
  152. }
  153. addElLabel($el, message);
  154. addElControls($el, wrapperId);
  155. };
  156. const handleFocus = e => {
  157. const slideEl = e.target.closest(`.${swiper.params.slideClass}`);
  158. if (!slideEl || !swiper.slides.includes(slideEl)) return;
  159. const isActive = swiper.slides.indexOf(slideEl) === swiper.activeIndex;
  160. const isVisible = swiper.params.watchSlidesProgress && swiper.visibleSlides && swiper.visibleSlides.includes(slideEl);
  161. if (isActive || isVisible) return;
  162. swiper.slideTo(swiper.slides.indexOf(slideEl), 0);
  163. };
  164. function init() {
  165. const params = swiper.params.a11y;
  166. swiper.$el.append(liveRegion); // Container
  167. const $containerEl = swiper.$el;
  168. if (params.containerRoleDescriptionMessage) {
  169. addElRoleDescription($containerEl, params.containerRoleDescriptionMessage);
  170. }
  171. if (params.containerMessage) {
  172. addElLabel($containerEl, params.containerMessage);
  173. } // Wrapper
  174. const $wrapperEl = swiper.$wrapperEl;
  175. const wrapperId = $wrapperEl.attr('id') || `swiper-wrapper-${getRandomNumber(16)}`;
  176. const live = swiper.params.autoplay && swiper.params.autoplay.enabled ? 'off' : 'polite';
  177. addElId($wrapperEl, wrapperId);
  178. addElLive($wrapperEl, live); // Slide
  179. if (params.itemRoleDescriptionMessage) {
  180. addElRoleDescription($(swiper.slides), params.itemRoleDescriptionMessage);
  181. }
  182. addElRole($(swiper.slides), params.slideRole);
  183. const slidesLength = swiper.params.loop ? swiper.slides.filter(el => !el.classList.contains(swiper.params.slideDuplicateClass)).length : swiper.slides.length;
  184. swiper.slides.each((slideEl, index) => {
  185. const $slideEl = $(slideEl);
  186. const slideIndex = swiper.params.loop ? parseInt($slideEl.attr('data-swiper-slide-index'), 10) : index;
  187. const ariaLabelMessage = params.slideLabelMessage.replace(/\{\{index\}\}/, slideIndex + 1).replace(/\{\{slidesLength\}\}/, slidesLength);
  188. addElLabel($slideEl, ariaLabelMessage);
  189. }); // Navigation
  190. let $nextEl;
  191. let $prevEl;
  192. if (swiper.navigation && swiper.navigation.$nextEl) {
  193. $nextEl = swiper.navigation.$nextEl;
  194. }
  195. if (swiper.navigation && swiper.navigation.$prevEl) {
  196. $prevEl = swiper.navigation.$prevEl;
  197. }
  198. if ($nextEl && $nextEl.length) {
  199. initNavEl($nextEl, wrapperId, params.nextSlideMessage);
  200. }
  201. if ($prevEl && $prevEl.length) {
  202. initNavEl($prevEl, wrapperId, params.prevSlideMessage);
  203. } // Pagination
  204. if (hasClickablePagination()) {
  205. swiper.pagination.$el.on('keydown', classesToSelector(swiper.params.pagination.bulletClass), onEnterOrSpaceKey);
  206. } // Tab focus
  207. swiper.$el.on('focus', handleFocus, true);
  208. }
  209. function destroy() {
  210. if (liveRegion && liveRegion.length > 0) liveRegion.remove();
  211. let $nextEl;
  212. let $prevEl;
  213. if (swiper.navigation && swiper.navigation.$nextEl) {
  214. $nextEl = swiper.navigation.$nextEl;
  215. }
  216. if (swiper.navigation && swiper.navigation.$prevEl) {
  217. $prevEl = swiper.navigation.$prevEl;
  218. }
  219. if ($nextEl) {
  220. $nextEl.off('keydown', onEnterOrSpaceKey);
  221. }
  222. if ($prevEl) {
  223. $prevEl.off('keydown', onEnterOrSpaceKey);
  224. } // Pagination
  225. if (hasClickablePagination()) {
  226. swiper.pagination.$el.off('keydown', classesToSelector(swiper.params.pagination.bulletClass), onEnterOrSpaceKey);
  227. } // Tab focus
  228. swiper.$el.off('focus', handleFocus, true);
  229. }
  230. on('beforeInit', () => {
  231. liveRegion = $(`<span class="${swiper.params.a11y.notificationClass}" aria-live="assertive" aria-atomic="true"></span>`);
  232. });
  233. on('afterInit', () => {
  234. if (!swiper.params.a11y.enabled) return;
  235. init();
  236. });
  237. on('fromEdge toEdge afterInit lock unlock', () => {
  238. if (!swiper.params.a11y.enabled) return;
  239. updateNavigation();
  240. });
  241. on('paginationUpdate', () => {
  242. if (!swiper.params.a11y.enabled) return;
  243. updatePagination();
  244. });
  245. on('destroy', () => {
  246. if (!swiper.params.a11y.enabled) return;
  247. destroy();
  248. });
  249. }