focus-trap - npm Package Compare versions

Comparing version 2.4.2 to 2.4.3

CHANGELOG.md

 # Changelog
 
+## 2.4.3
+
+- Fixed: TypeScript signature for `activate` function.
+
 ## 2.4.2
@@ -4,0 +8,0 @@

index.d.ts

@@ -66,4 +66,4 @@ declare module "focus-trap" {
   export interface FocusTrap {
-    activate(activateOptions: ActivateOptions): void;
-    deactivate(deactivateOptions: DeactivateOptions): void;
+    activate(activateOptions?: ActivateOptions): void;
+    deactivate(deactivateOptions?: DeactivateOptions): void;
     pause(): void;
@@ -70,0 +70,0 @@ unpause(): void;

package.json

 {
   "name": "focus-trap",
-  "version": "2.4.2",
+  "version": "2.4.3",
   "description": "Trap focus within a DOM node.",
@@ -5,0 +5,0 @@ "main": "index.js",

README.md

@@ -65,3 +65,3 @@ # focus-trap
 
-### focusTrap.activate()
+### focusTrap.activate([activateOptions])
 
@@ -80,2 +80,8 @@ Activates the focus trap, adding various event listeners to the document.
 
+`activateOptions`:
+
+These options are used to override the focus trap's default behavior for this particular activation.
+
+- **onActivate** {function | null | false}: Default: whatever you chose for `createOptions.onActivate`. `null` or `false` are the equivalent of a `noop`.
+
 ### focusTrap.deactivate([deactivateOptions])
@@ -82,0 +88,0 @@

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

20205

increased by1.82%

Number of lines in readme file

153

increased by4.08%

No dependency changes