@deque/cauldron-react 6.12.0 → 6.13.0

package/lib/types.d.ts

@@ -11,3 +11,4 @@ export declare namespace Cauldron {
  * Explicit equivalent of Exclude<ReactNode, boolean | null | undefined>
  */
 export type ContentNode = string | number | ReactPortal | ReactElement;
+export type ElementOrRef<E extends Element> = E | React.RefObject<E> | React.MutableRefObject<E>;

package/lib/utils/resolveElement.d.ts

@@ -1,6 +1,6 @@
-import type { RefObject, MutableRefObject } from 'react';
+import type { ElementOrRef } from '../types';
 /**
  * When an element can be passed as a value that is either an element or an
  * elementRef, this will resolve the property down to the resulting element
  */
-export default function resolveElement<T extends Element = Element>(elementOrRef: T | RefObject<T> | MutableRefObject<T> | undefined): T | null;
+export default function resolveElement<T extends Element = Element>(elementOrRef: ElementOrRef<T> | undefined): T | null;

package/lib/utils/useFocusTrap.d.ts

@@ -0,0 +1,34 @@
+import type { ElementOrRef } from '../types';
+type FocusTrapMetadata = {
+    targetElement: Element;
+    lastFocusedElement: HTMLElement | null;
+    suspended: boolean;
+};
+type FocusTrap = {
+    initialFocusElement: HTMLElement | null;
+    destroy: () => void;
+} & FocusTrapMetadata;
+export default function useFocusTrap<TargetElement extends Element = Element, FocusElement extends HTMLElement = HTMLElement>(target: ElementOrRef<TargetElement>, options?: {
+    /**
+     * When set to false, deactivates the focus trap. This can be necessary if
+     * a component needs to conditionally manage focus traps.
+     */
+    disabled?: boolean;
+    /**
+     * When the trap is activated, an optional custom element or ref
+     * can be provided to override the default initial focus element behavior.
+     */
+    initialFocusElement?: ElementOrRef<FocusElement>;
+    /**
+     * When set to true and the trap is deactivated, this will return focus
+     * back to the original active element or the return focus element if
+     * provided.
+     */
+    returnFocus?: boolean;
+    /**
+     * When the trap is deactivated, an optional custom element or ref
+     * can be provided to override the default active element behavior.
+     */
+    returnFocusElement?: ElementOrRef<FocusElement>;
+}): React.RefObject<Readonly<FocusTrap>>;
+export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@deque/cauldron-react",
-  "version": "6.12.0",
+  "version": "6.13.0",
   "license": "MPL-2.0",
   "description": "Fully accessible react components library for Deque Cauldron",
   "homepage": "https://cauldron.dequelabs.com/",
@@ -23,13 +23,11 @@
     "test": "jest --maxWorkers=1 --coverage"
   },
   "dependencies": {
-    "@popperjs/core": "^2.5.4",
+    "@floating-ui/react-dom": "^2.1.2",
     "classnames": "^2.2.6",
-    "focus-trap-react": "^10.2.3",
     "focusable": "^2.3.0",
     "keyname": "^0.1.0",
     "react-id-generator": "^3.0.1",
-    "react-popper": "^2.2.4",
     "react-syntax-highlighter": "^15.5.0",
     "tslib": "^2.4.0"
   },