Update docs

primer · Sep 20, 2024 · 67d1e54 · 67d1e54
1 parent d5b5ec9
commit 67d1e54
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 3 deletions.
diff --git a/packages/react/src/Overlay/Overlay.docs.json b/packages/react/src/Overlay/Overlay.docs.json
@@ -112,6 +112,12 @@
       "defaultValue": "",
       "description": "If defined, Overlays will be rendered in the named portal. See also `Portal`."
     },
+    {
+      "name": "focusTrap",
+      "type": "string",
+      "defaultValue": "true",
+      "description": "Determines if the `Overlay` recieves a focus trap or not"
+    },
     {
       "name": "sx",
       "type": "SystemStyleObject"

diff --git a/packages/react/src/Overlay/Overlay.tsx b/packages/react/src/Overlay/Overlay.tsx
@@ -204,11 +204,11 @@ const Overlay = React.forwardRef<HTMLDivElement, OwnOverlayProps>(
     // To be backwards compatible with the old Overlay, we need to set the left prop if x-position is not specified
     const leftPosition: React.CSSProperties = left === undefined && right === undefined ? {left: 0} : {left}
 
-    const dialog = role && role !== 'dialog' ? true : false
+    const nonDialog = role && role !== 'dialog' ? true : false
 
     useFocusTrap({
       containerRef: overlayRef,
-      disabled: !focusTrap || dialog,
+      disabled: !focusTrap || nonDialog,
     })
 
     return (
@@ -217,7 +217,7 @@ const Overlay = React.forwardRef<HTMLDivElement, OwnOverlayProps>(
           height={height}
           width={width}
           role={role || 'dialog'}
-          aria-modal={dialog ? undefined : 'true'}
+          aria-modal={nonDialog ? undefined : 'true'}
           {...rest}
           ref={overlayRef}
           style={