flowbite-svelte 0.22.21 → 0.22.22

package/CHANGELOG.md

@@ -2,6 +2,13 @@
 
 All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
 
+### [0.22.22](https://github.com/themesberg/flowbite-svelte/compare/v0.22.21...v0.22.22) (2022-07-28)
+
+
+### Features
+
+* focus trap for modals ([08604ac](https://github.com/themesberg/flowbite-svelte/commit/08604ac3475f28a5a35c037e47ecfc13ee13b877))
+
 ### [0.22.21](https://github.com/themesberg/flowbite-svelte/compare/v0.22.20...v0.22.21) (2022-07-28)
 
 

package/modals/Modal.svelte

@@ -1,6 +1,7 @@
 <script>import { createEventDispatcher } from 'svelte';
 import { setContext } from 'svelte';
 import CloseButton from '../utils/CloseButton.svelte';
+import focusTrap from '../utils/focusTrap';
 export let open = false;
 export let title = undefined;
 export let size = 'md';
@@ -18,15 +19,14 @@ const allPlacementClasses = [
     'items-end'
 ];
 let backdropEl;
-function init(node, _visible) {
+function init(node, _open) {
     getPlacementClasses().map((c) => node.classList.add(c));
-    if (_visible)
-        createBackdrop(node);
+    _open && createBackdrop(node);
     return {
-        update(_visible) {
+        update(_open) {
             allPlacementClasses.map((c) => node.classList.remove(c));
             getPlacementClasses().map((c) => node.classList.add(c));
-            _visible ? createBackdrop(node) : destroyBackdrop(node);
+            _open ? createBackdrop(node) : destroyBackdrop(node);
         },
         destroy() {
             destroyBackdrop(node);
@@ -44,17 +44,17 @@ function createBackdrop(node) {
         const body = document.querySelector('body');
         body.append(backdropEl);
         body.style.overflow = 'hidden';
-        body.addEventListener('keydown', handleEscape, true);
+        document.addEventListener('keydown', handleEscape, true);
     }
     dispatch('show', node);
 }
 function destroyBackdrop(node) {
     const body = document.querySelector('body');
     body.style.overflow = 'auto';
-    body.removeEventListener('keydown', handleEscape, true);
     if (backdropEl)
         backdropEl.remove();
     backdropEl = undefined;
+    document.removeEventListener('keydown', handleEscape, true);
     dispatch('hide', node);
 }
 function getPlacementClasses() {
@@ -110,6 +110,7 @@ function hide() {
 	aria-modal={open ? 'true' : undefined}
 	role={open ? 'dialog' : undefined}
 	use:init={open}
+	use:focusTrap={open}
 	on:click={onButtonsClick}
 >
 	<div class="relative p-4 w-full {sizes[size]} h-full md:h-auto">

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "flowbite-svelte",
-  "version": "0.22.21",
+  "version": "0.22.22",
   "description": "Flowbite components for Svelte",
   "main": "index.js",
   "author": {
@@ -236,6 +236,7 @@
     "./utils/CloseButton.svelte": "./utils/CloseButton.svelte",
     "./utils/OptsButton.svelte": "./utils/OptsButton.svelte",
     "./utils/clickOutside": "./utils/clickOutside.js",
+    "./utils/focusTrap": "./utils/focusTrap.js",
     "./utils/generateId": "./utils/generateId.js"
   },
   "svelte": "./index.js"

package/utils/focusTrap.js

@@ -0,0 +1,61 @@
+//
+// Focus trap copied from https://uxdesign.cc/how-to-trap-focus-inside-modal-to-make-it-ada-compliant-6a50f9a70700
+//
+
+// add all the elements inside modal which you want to make focusable
+const focusableElements =
+	'button, [href], input, select, textarea, [tabindex]:not([tabindex="-1"])';
+
+function getFocusable(node) {
+	const focusableContent = node.querySelectorAll(focusableElements);
+	return [focusableContent[0], focusableContent[focusableContent.length - 1]];
+}
+
+export default function focusTrap(node, _open) {
+	let firstFocusableElement, lastFocusableElement; // first and last element to be focused inside modal
+
+	function handleFocusTrap(e) {
+		let isTabPressed = e.key === 'Tab' || e.keyCode === 9;
+
+		if (!isTabPressed) {
+			return;
+		}
+
+		if (e.shiftKey) {
+			// if shift key pressed for shift + tab combination
+			if (document.activeElement === firstFocusableElement) {
+				lastFocusableElement.focus(); // add focus for the last focusable element
+				e.preventDefault();
+			}
+		} else {
+			// if tab key is pressed
+			if (document.activeElement === lastFocusableElement) {
+				// if focused has reached to last focusable element then focus first focusable element after pressing tab
+				firstFocusableElement.focus(); // add focus for the first focusable element
+				e.preventDefault();
+			}
+		}
+	}
+
+	if (_open) {
+		[firstFocusableElement, lastFocusableElement] = getFocusable(node);
+		document.addEventListener('keydown', handleFocusTrap, true);
+		firstFocusableElement.focus();
+	}
+
+	return {
+		update(_open) {
+			if (_open) {
+				[firstFocusableElement, lastFocusableElement] = getFocusable(node);
+				document.addEventListener('keydown', handleFocusTrap, true);
+				firstFocusableElement.focus();
+			} else {
+				document.removeEventListener('keydown', handleFocusTrap, true);
+			}
+		},
+
+		destroy() {
+			document.removeEventListener('keydown', handleFocusTrap, true);
+		}
+	};
+}