vanilla-aria-modals 1.1.1 → 1.1.3

package/CHANGELOG.md

@@ -4,6 +4,14 @@ All notable changes to this project will be documented in this file. Dates use I
 
 The format is based on [Keep a Changelog](https://keepachangelog.com/).
 
+## [1.1.3] - 2026-02-16
+### Fixed
+- Add missing parameter titles to `README.md`. 
+
+## [1.1.2] - 2026-02-15
+### Fixed
+- Unify `README.md` formatting for all bullet points. Previously, in some Markdown views, the bullet points format from the `addA11yEvents` method was broken due to a code block. This has been corrected so everything now displays consistently.
+
 ## [1.1.1] - 2026-02-15
 ### Fixed
 - Fix typos, update changelog, and add an example wrapper usage for the `closeHandler`.

package/README.md

@@ -124,27 +124,28 @@ Registers ARIA events and modal stacking handling:
 #### Parameters
 **Takes parameters as a single object, which are destructured inside the method.**
 
-- **`modalKey: string;`** Unique modal identifier. Used for stacking and event management.
+- **`modalKey: string;`** Unique modal identifier. Used for stacking and event management. 
 - **`modalLm?: HTMLElement | null;`** *(optional)* The main modal element. Used to trap focus inside the modal. 
-- **`modalLmOuterLimits?: HTMLElement | null;`** *(optional)* The container that defines the modal boundary. Used to detect clicks outside the modal. **modalLm** is usually used here, but depending on the UI we may not want to trap focus into the same container we want to close, maybe just in a part of it.
-- **`closeLms?: HTMLElement[] | null;`** *(optional)* Array of elements that should trigger closing the modal (e.g., close buttons).
-- **`exemptLms?: HTMLElement[];`** *(optional)* Array of elements that should not trigger closing even if clicked outside.
-- **`closeHandler: (e: Event, modalKey: string) => void;`** Function to call when the modal should close. Usually should call **removeA11yEvents()**. Automatically receives the event **(e)** and **(modalKey)** from the wrapper; no need to pass as arguments. It’s up to the caller whether to use them.
+- **`modalLmOuterLimits?: HTMLElement | null;`** *(optional)* The container that defines the modal boundary. Used to detect clicks outside the modal. **modalLm** is usually used here, but depending on the UI we may not want to trap focus into the same container we want to close, maybe just in a part of it. 
+- **`closeLms?: HTMLElement[] | null;`** *(optional)* Array of elements that should trigger closing the modal (e.g., close buttons). 
+- **`exemptLms?: HTMLElement[];`** *(optional)* Array of elements that should not trigger closing even if clicked outside. 
+- **`closeHandler: (e: Event, modalKey: string) => void;`** Function to call at modal close. Usually should call **removeA11yEvents()**. Automatically receives the event **(e)** and **(modalKey)** from the wrapper; no need to pass as arguments. It’s up to the caller whether to use them.
+
 If you need to pass additional arguments to the close handler, you can wrap it in a function that returns a handler accepting only the two parameters (`e` and `modalKey`):
   
-  ```js
-  const closeModalWrapper = (...args) => {
-    // Returns a handler that the utility calls internally with e and modalKey
-    return (e, modalKey) => {
-      // Your logic for the close handler here 
-      // Access to parameters thanks to closures
-    }
+```js
+const closeModalWrapper = (...args) => {
+  // Returns a handler that the utility calls internally with e and modalKey
+  return (e, modalKey) => {
+    // Your logic for the close handler here 
+    // Access to parameters thanks to closures
   }
+}
 
-  modalHandler.addA11yEvents({
-    closeHandler: closeModalWrapper(...args)
-  });
-  ```
+modalHandler.addA11yEvents({
+  closeHandler: closeModalWrapper(...args)
+});
+```
 
 Returns `void`
 
@@ -209,6 +210,8 @@ Returns `void`
 ### generateKey()
 Generates a unique identifier for the modal.
 
+#### Parameters
+
 - **`prefix?: string;`** Optional prefix to modify the generated modal key.
 
 Returns `string`. The generated modal key to be used later in the code.
@@ -223,6 +226,8 @@ Returns `void`
 
 Re-attaches the focus-trapping event listener for a specific modal. The internal **trapFocus** method already queries the DOM on each keyboard event, so in most cases, manually rebinding is not necessary.
 
+#### Parameters
+
 - **`modalKey: string;`** The unique key of the modal whose focus trap should be rebound.
 
-returns `void`
+Returns `void`

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "vanilla-aria-modals",
-  "version": "1.1.1",
+  "version": "1.1.3",
   "description": "Framework-agnostic utility for managing accessibility in modals or modal-like UIs, including modal stacking, focus management, and closing via Escape key or outside click.",
   "main": "src/ModalHandler.js",
   "scripts": {