@yamada-ui/modal 0.1.11 → 0.2.0

package/dist/modal-overlay.mjs

@@ -1,6 +1,6 @@
 import {
   ModalOverlay
-} from "./chunk-IFQ6QPEJ.mjs";
+} from "./chunk-MCXUVWUW.mjs";
 export {
   ModalOverlay
 };

package/dist/modal.d.ts

@@ -3,30 +3,96 @@ import { HTMLUIProps, ThemeProps, CSSUIObject, Token, CSSUIProps } from '@yamada
 import { FocusLockProps } from '@yamada-ui/focus-lock';
 import { HTMLMotionProps, MotionTransitionProperties } from '@yamada-ui/motion';
 
-type Placement = 'center' | 'top' | 'right' | 'bottom' | 'left' | 'top-left' | 'top-right' | 'bottom-left' | 'bottom-right';
-type ScrollBehavior = 'inside' | 'outside';
-type Animation = 'scale' | 'top' | 'right' | 'left' | 'bottom' | 'none';
 type ModalContext = ModalOptions & {
     styles: Record<string, CSSUIObject>;
 };
 declare const useModal: () => ModalContext;
 
 type ModalOptions = Pick<FocusLockProps, 'autoFocus' | 'initialFocusRef' | 'finalFocusRef' | 'restoreFocus' | 'lockFocusAcrossFrames'> & {
+    /**
+     * If `true`, the open will be opened.
+     */
     isOpen: boolean;
+    /**
+     * Callback invoked to close the modal.
+     */
     onClose?: () => void;
+    /**
+     * Callback fired when the overlay is clicked.
+     */
     onOverlayClick?: () => void;
+    /**
+     * Callback fired when the escape key is pressed and focus is within modal.
+     */
     onEsc?(): void;
+    /**
+     * Callback function to run side effects after the modal has closed.
+     */
     onCloseComplete?: () => void;
-    placement?: Token<Placement>;
+    /**
+     * The placement of the modal.
+     *
+     * @default 'center'
+     */
+    placement?: Token<'center' | 'top' | 'right' | 'bottom' | 'left' | 'top-left' | 'top-right' | 'bottom-left' | 'bottom-right'>;
+    /**
+     * The CSS `padding` property.
+     */
     outside?: CSSUIProps['p'];
+    /**
+     * If `true`, display the modal close button.
+     *
+     * @default true
+     */
     withCloseButton?: boolean;
+    /**
+     * If `true`, display the modal overlay.
+     *
+     * @default true
+     */
     withOverlay?: boolean;
+    /**
+     * Handle zoom or pinch gestures on iOS devices when scroll locking is enabled.
+     *
+     * @default false.
+     */
     allowPinchZoom?: boolean;
-    scrollBehavior?: ScrollBehavior;
+    /**
+     * Where scroll behavior should originate.
+     *
+     * - `inside`: scroll only occurs within the `ModalBody`.
+     * - `outside`: the entire `ModalContent` will scroll within the viewport.
+     *
+     * @default 'inside'
+     */
+    scrollBehavior?: 'inside' | 'outside';
+    /**
+     * If `true`, scrolling will be disabled on the `body` when the modal opens.
+     *
+     * @default true
+     */
     blockScrollOnMount?: boolean;
+    /**
+     * If `true`, the modal will close when the overlay is clicked.
+     *
+     * @default true
+     */
     closeOnOverlay?: boolean;
+    /**
+     * If `true`, the modal will close when the `Esc` key is pressed.
+     *
+     * @default true
+     */
     closeOnEsc?: boolean;
-    animation?: Animation;
+    /**
+     * The animation of the tooltip.
+     *
+     * @default 'scale'
+     */
+    animation?: 'scale' | 'top' | 'right' | 'left' | 'bottom' | 'none';
+    /**
+     * The animation duration.
+     */
     duration?: MotionTransitionProperties['duration'];
 };
 type ModalProps = Omit<HTMLUIProps<'section'>, 'scrollBehavior' | 'animation'> & Omit<HTMLMotionProps<'section'>, 'color' | 'transition'> & ThemeProps<'Modal'> & ModalOptions;

package/dist/modal.js

@@ -34,6 +34,11 @@ var import_utils8 = require("@yamada-ui/utils");
 var import_react = require("react");
 var import_react_remove_scroll = require("react-remove-scroll");
 
+// src/drawer.tsx
+var import_core7 = require("@yamada-ui/core");
+var import_transitions2 = require("@yamada-ui/transitions");
+var import_utils7 = require("@yamada-ui/utils");
+
 // src/modal-overlay.tsx
 var import_core = require("@yamada-ui/core");
 var import_motion = require("@yamada-ui/motion");
@@ -274,9 +279,6 @@ var DialogFooter = (0, import_core6.forwardRef)(
 );
 
 // src/drawer.tsx
-var import_core7 = require("@yamada-ui/core");
-var import_transitions2 = require("@yamada-ui/transitions");
-var import_utils7 = require("@yamada-ui/utils");
 var import_jsx_runtime7 = require("react/jsx-runtime");
 var [DrawerProvider, useDrawer] = (0, import_utils7.createContext)({
   name: `DrawerContext`,

package/dist/modal.mjs

@@ -1,7 +1,7 @@
 import {
   Modal,
   useModal
-} from "./chunk-IFQ6QPEJ.mjs";
+} from "./chunk-MCXUVWUW.mjs";
 export {
   Modal,
   useModal

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@yamada-ui/modal",
-  "version": "0.1.11",
+  "version": "0.2.0",
   "description": "Yamada UI modal component",
   "keywords": [
     "yamada",
@@ -36,15 +36,15 @@
   },
   "dependencies": {
     "react-remove-scroll": "^2.5.4",
-    "@yamada-ui/core": "0.2.3",
+    "@yamada-ui/core": "0.3.1",
     "@yamada-ui/utils": "0.1.1",
-    "@yamada-ui/motion": "0.1.10",
-    "@yamada-ui/portal": "0.1.2",
-    "@yamada-ui/button": "0.1.10",
-    "@yamada-ui/focus-lock": "0.1.1",
-    "@yamada-ui/close-button": "0.1.10",
-    "@yamada-ui/transitions": "0.1.10",
-    "@yamada-ui/use-value": "0.1.10"
+    "@yamada-ui/motion": "0.2.0",
+    "@yamada-ui/portal": "0.2.0",
+    "@yamada-ui/button": "0.2.0",
+    "@yamada-ui/focus-lock": "0.2.0",
+    "@yamada-ui/close-button": "0.2.0",
+    "@yamada-ui/transitions": "0.2.0",
+    "@yamada-ui/use-value": "0.1.12"
   },
   "devDependencies": {
     "react": "^18.0.0",