@tamagui/dismissable 1.0.1-beta.166 → 1.0.1-beta.168

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tamagui/dismissable",
-  "version": "1.0.1-beta.166",
+  "version": "1.0.1-beta.168",
   "sideEffects": true,
   "source": "src/index.ts",
   "types": "./types/index.d.ts",
@@ -22,16 +22,16 @@
   },
   "dependencies": {
     "@radix-ui/react-use-escape-keydown": "^0.1.0",
-    "@tamagui/compose-refs": "^1.0.1-beta.166",
-    "@tamagui/core": "^1.0.1-beta.166",
-    "@tamagui/use-event": "^1.0.1-beta.166"
+    "@tamagui/compose-refs": "^1.0.1-beta.168",
+    "@tamagui/core": "^1.0.1-beta.168",
+    "@tamagui/use-event": "^1.0.1-beta.168"
   },
   "peerDependencies": {
     "react": "*",
     "react-dom": "*"
   },
   "devDependencies": {
-    "@tamagui/build": "^1.0.1-beta.166",
+    "@tamagui/build": "^1.0.1-beta.168",
     "react": "*",
     "react-dom": "*"
   },

package/types/DismissableProps.d.ts

@@ -1,12 +1,40 @@
 import React from 'react';
 import { FocusOutsideEvent, PointerDownOutsideEvent } from './Dismissable';
 export interface DismissableProps {
+    /**
+     * When `true`, hover/focus/click interactions will be disabled on elements outside
+     * the `Dismissable`. Users will need to click twice on outside elements to
+     * interact with them: once to close the `Dismissable`, and again to trigger the element.
+     */
     disableOutsidePointerEvents?: boolean;
+    /**
+     * Event handler called when the escape key is down.
+     * Can be prevented.
+     */
     onEscapeKeyDown?: (event: KeyboardEvent) => void;
+    /**
+     * Event handler called when the a `pointerdown` event happens outside of the `Dismissable`.
+     * Can be prevented.
+     */
     onPointerDownOutside?: (event: PointerDownOutsideEvent) => void;
+    /**
+     * Event handler called when the focus moves outside of the `Dismissable`.
+     * Can be prevented.
+     */
     onFocusOutside?: (event: FocusOutsideEvent) => void;
+    /**
+     * Event handler called when an interaction happens outside the `Dismissable`.
+     * Specifically, when a `pointerdown` event happens outside or focus moves outside of it.
+     * Can be prevented.
+     */
     onInteractOutside?: (event: PointerDownOutsideEvent | FocusOutsideEvent) => void;
+    /**
+     * Handler called when the `Dismissable` should be dismissed
+     */
     onDismiss?: () => void;
+    /**
+     * When using animations on exit, may want to simualte force unmount early
+     */
     forceUnmount?: boolean;
     children?: React.ReactNode;
 }