base-vaul 0.0.1 → 0.1.0

package/dist/index.d.mts

@@ -1,147 +1,186 @@
-import * as _base_ui_react from '@base-ui/react';
-import { Dialog } from '@base-ui/react';
-import React from 'react';
+import * as _base_ui_react0 from "@base-ui/react";
+import { Dialog } from "@base-ui/react";
+import React from "react";
+import * as react_jsx_runtime0 from "react/jsx-runtime";
 
+//#region src/context.d.ts
 type BaseUIMouseEvent = React.MouseEvent<HTMLDivElement> & {
-    preventBaseUIHandler: () => void;
-    readonly baseUIHandlerPrevented?: boolean | undefined;
+  preventBaseUIHandler: () => void;
+  readonly baseUIHandlerPrevented?: boolean | undefined;
 };
-
+//#endregion
+//#region src/index.d.ts
 interface WithFadeFromProps {
-    /**
-     * Array of numbers from 0 to 100 that corresponds to % of the screen a given snap point should take up.
-     * Should go from least visible. Example `[0.2, 0.5, 0.8]`.
-     * You can also use px values, which doesn't take screen height into account.
-     */
-    snapPoints: (number | string)[];
-    /**
-     * Index of a `snapPoint` from which the overlay fade should be applied. Defaults to the last snap point.
-     */
-    fadeFromIndex: number;
+  /**
+   * Array of numbers from 0 to 100 that corresponds to % of the screen a given snap point should take up.
+   * Should go from least visible. Example `[0.2, 0.5, 0.8]`.
+   * You can also use px values, which doesn't take screen height into account.
+   */
+  snapPoints: (number | string)[];
+  /**
+   * Index of a `snapPoint` from which the overlay fade should be applied. Defaults to the last snap point.
+   */
+  fadeFromIndex: number;
 }
 interface WithoutFadeFromProps {
-    /**
-     * Array of numbers from 0 to 100 that corresponds to % of the screen a given snap point should take up.
-     * Should go from least visible. Example `[0.2, 0.5, 0.8]`.
-     * You can also use px values, which doesn't take screen height into account.
-     */
-    snapPoints?: (number | string)[];
-    fadeFromIndex?: never;
+  /**
+   * Array of numbers from 0 to 100 that corresponds to % of the screen a given snap point should take up.
+   * Should go from least visible. Example `[0.2, 0.5, 0.8]`.
+   * You can also use px values, which doesn't take screen height into account.
+   */
+  snapPoints?: (number | string)[];
+  fadeFromIndex?: never;
 }
 type DialogProps = {
-    activeSnapPoint?: number | string | null;
-    setActiveSnapPoint?: (snapPoint: number | string | null) => void;
-    children?: React.ReactNode;
-    open?: boolean;
-    /**
-     * Number between 0 and 1 that determines when the drawer should be closed.
-     * Example: threshold of 0.5 would close the drawer if the user swiped for 50% of the height of the drawer or more.
-     * @default 0.25
-     */
-    closeThreshold?: number;
-    /**
-     * When `true` the `body` doesn't get any styles assigned from Vaul
-     */
-    noBodyStyles?: boolean;
-    onOpenChange?: (open: boolean) => void;
-    shouldScaleBackground?: boolean;
-    /**
-     * When `false` we don't change body's background color when the drawer is open.
-     * @default true
-     */
-    setBackgroundColorOnScale?: boolean;
-    /**
-     * Duration for which the drawer is not draggable after scrolling content inside of the drawer.
-     * @default 500ms
-     */
-    scrollLockTimeout?: number;
-    /**
-     * When `true`, don't move the drawer upwards if there's space, but rather only change it's height so it's fully scrollable when the keyboard is open
-     */
-    fixed?: boolean;
-    /**
-     * When `true` only allows the drawer to be dragged by the `<Drawer.Handle />` component.
-     * @default false
-     */
-    handleOnly?: boolean;
-    /**
-     * When `false` dragging, clicking outside, pressing esc, etc. will not close the drawer.
-     * Use this in comination with the `open` prop, otherwise you won't be able to open/close the drawer.
-     * @default true
-     */
-    dismissible?: boolean;
-    onDrag?: (event: BaseUIMouseEvent, percentageDragged: number) => void;
-    onRelease?: (event: BaseUIMouseEvent, open: boolean) => void;
-    /**
-     * When `false` it allows to interact with elements outside of the drawer without closing it.
-     * @default true
-     */
-    modal?: boolean;
-    nested?: boolean;
-    onClose?: () => void;
-    /**
-     * Direction of the drawer. Can be `top` or `bottom`, `left`, `right`.
-     * @default 'bottom'
-     */
-    direction?: 'top' | 'bottom' | 'left' | 'right';
-    /**
-     * Opened by default, skips initial enter animation. Still reacts to `open` state changes
-     * @default false
-     */
-    defaultOpen?: boolean;
-    /**
-     * When set to `true` prevents scrolling on the document body on mount, and restores it on unmount.
-     * @default false
-     */
-    disablePreventScroll?: boolean;
-    /**
-     * When `true` Vaul will reposition inputs rather than scroll then into view if the keyboard is in the way.
-     * Setting it to `false` will fall back to the default browser behavior.
-     * @default true when {@link snapPoints} is defined
-     */
-    repositionInputs?: boolean;
-    /**
-     * Disabled velocity based swiping for snap points.
-     * This means that a snap point won't be skipped even if the velocity is high enough.
-     * Useful if each snap point in a drawer is equally important.
-     * @default false
-     */
-    snapToSequentialPoint?: boolean;
-    container?: HTMLElement | null;
-    /**
-     * Gets triggered after the open or close animation ends, it receives an `open` argument with the `open` state of the drawer by the time the function was triggered.
-     * Useful to revert any state changes for example.
-     */
-    onAnimationEnd?: (open: boolean) => void;
-    preventScrollRestoration?: boolean;
-    autoFocus?: boolean;
+  activeSnapPoint?: number | string | null;
+  setActiveSnapPoint?: (snapPoint: number | string | null) => void;
+  children?: React.ReactNode;
+  open?: boolean;
+  /**
+   * Number between 0 and 1 that determines when the drawer should be closed.
+   * Example: threshold of 0.5 would close the drawer if the user swiped for 50% of the height of the drawer or more.
+   * @default 0.25
+   */
+  closeThreshold?: number;
+  /**
+   * When `true` the `body` doesn't get any styles assigned from Vaul
+   */
+  noBodyStyles?: boolean;
+  onOpenChange?: (open: boolean) => void;
+  shouldScaleBackground?: boolean;
+  /**
+   * When `false` we don't change body's background color when the drawer is open.
+   * @default true
+   */
+  setBackgroundColorOnScale?: boolean;
+  /**
+   * Duration for which the drawer is not draggable after scrolling content inside of the drawer.
+   * @default 500ms
+   */
+  scrollLockTimeout?: number;
+  /**
+   * When `true`, don't move the drawer upwards if there's space, but rather only change it's height so it's fully scrollable when the keyboard is open
+   */
+  fixed?: boolean;
+  /**
+   * When `true` only allows the drawer to be dragged by the `<Drawer.Handle />` component.
+   * @default false
+   */
+  handleOnly?: boolean;
+  /**
+   * When `false` dragging, clicking outside, pressing esc, etc. will not close the drawer.
+   * Use this in comination with the `open` prop, otherwise you won't be able to open/close the drawer.
+   * @default true
+   */
+  dismissible?: boolean;
+  onDrag?: (event: BaseUIMouseEvent, percentageDragged: number) => void;
+  onRelease?: (event: BaseUIMouseEvent, open: boolean) => void;
+  /**
+   * When `false` it allows to interact with elements outside of the drawer without closing it.
+   * @default true
+   */
+  modal?: boolean;
+  nested?: boolean;
+  onClose?: () => void;
+  /**
+   * Direction of the drawer. Can be `top` or `bottom`, `left`, `right`.
+   * @default 'bottom'
+   */
+  direction?: "top" | "bottom" | "left" | "right";
+  /**
+   * Opened by default, skips initial enter animation. Still reacts to `open` state changes
+   * @default false
+   */
+  defaultOpen?: boolean;
+  /**
+   * When set to `true` prevents scrolling on the document body on mount, and restores it on unmount.
+   * @default false
+   */
+  disablePreventScroll?: boolean;
+  /**
+   * When `true` Vaul will reposition inputs rather than scroll then into view if the keyboard is in the way.
+   * Setting it to `false` will fall back to the default browser behavior.
+   * @default true when {@link snapPoints} is defined
+   */
+  repositionInputs?: boolean;
+  /**
+   * Disabled velocity based swiping for snap points.
+   * This means that a snap point won't be skipped even if the velocity is high enough.
+   * Useful if each snap point in a drawer is equally important.
+   * @default false
+   */
+  snapToSequentialPoint?: boolean;
+  container?: HTMLElement | null;
+  /**
+   * Gets triggered after the open or close animation ends, it receives an `open` argument with the `open` state of the drawer by the time the function was triggered.
+   * Useful to revert any state changes for example.
+   */
+  onAnimationEnd?: (open: boolean) => void;
+  preventScrollRestoration?: boolean;
+  autoFocus?: boolean;
 } & (WithFadeFromProps | WithoutFadeFromProps);
-declare function Root({ open: openProp, onOpenChange, children, onDrag: onDragProp, onRelease: onReleaseProp, snapPoints, shouldScaleBackground, setBackgroundColorOnScale, closeThreshold, scrollLockTimeout, dismissible, handleOnly, fadeFromIndex, activeSnapPoint: activeSnapPointProp, setActiveSnapPoint: setActiveSnapPointProp, fixed, modal, onClose, nested, noBodyStyles, direction, defaultOpen, disablePreventScroll, snapToSequentialPoint, preventScrollRestoration, repositionInputs, onAnimationEnd, container, autoFocus, }: DialogProps): React.JSX.Element;
-declare const Overlay: React.ForwardRefExoticComponent<Omit<_base_ui_react.DialogBackdropProps & React.RefAttributes<HTMLDivElement>, "ref"> & React.RefAttributes<HTMLDivElement>>;
+declare function Root({
+  open: openProp,
+  onOpenChange,
+  children,
+  onDrag: onDragProp,
+  onRelease: onReleaseProp,
+  snapPoints,
+  shouldScaleBackground,
+  setBackgroundColorOnScale,
+  closeThreshold,
+  scrollLockTimeout,
+  dismissible,
+  handleOnly,
+  fadeFromIndex,
+  activeSnapPoint: activeSnapPointProp,
+  setActiveSnapPoint: setActiveSnapPointProp,
+  fixed,
+  modal,
+  onClose,
+  nested,
+  noBodyStyles,
+  direction,
+  defaultOpen,
+  disablePreventScroll,
+  snapToSequentialPoint,
+  preventScrollRestoration,
+  repositionInputs,
+  onAnimationEnd,
+  container,
+  autoFocus
+}: DialogProps): react_jsx_runtime0.JSX.Element;
+declare const Overlay: React.ForwardRefExoticComponent<Omit<_base_ui_react0.DialogBackdropProps & React.RefAttributes<HTMLDivElement>, "ref"> & React.RefAttributes<HTMLDivElement>>;
 type ContentProps = React.ComponentPropsWithoutRef<typeof Dialog.Popup>;
-declare const Content: React.ForwardRefExoticComponent<Omit<_base_ui_react.DialogPopupProps & React.RefAttributes<HTMLDivElement>, "ref"> & React.RefAttributes<HTMLDivElement>>;
-type HandleProps = React.ComponentPropsWithoutRef<'div'> & {
-    preventCycle?: boolean;
+declare const Content: React.ForwardRefExoticComponent<Omit<_base_ui_react0.DialogPopupProps & React.RefAttributes<HTMLDivElement>, "ref"> & React.RefAttributes<HTMLDivElement>>;
+type HandleProps = React.ComponentPropsWithoutRef<"div"> & {
+  preventCycle?: boolean;
 };
 declare const Handle: React.ForwardRefExoticComponent<Omit<React.DetailedHTMLProps<React.HTMLAttributes<HTMLDivElement>, HTMLDivElement>, "ref"> & {
-    preventCycle?: boolean | undefined;
+  preventCycle?: boolean;
 } & React.RefAttributes<HTMLDivElement>>;
-declare function NestedRoot({ onDrag, onOpenChange, open: nestedIsOpen, ...rest }: DialogProps): React.JSX.Element;
+declare function NestedRoot({
+  onDrag,
+  onOpenChange,
+  open: nestedIsOpen,
+  ...rest
+}: DialogProps): react_jsx_runtime0.JSX.Element;
 type PortalProps = React.ComponentPropsWithoutRef<typeof Dialog.Portal>;
-declare function Portal(props: PortalProps): React.JSX.Element;
+declare function Portal(props: PortalProps): react_jsx_runtime0.JSX.Element;
 declare const Drawer: {
-    Root: typeof Root;
-    NestedRoot: typeof NestedRoot;
-    Content: React.ForwardRefExoticComponent<Omit<_base_ui_react.DialogPopupProps & React.RefAttributes<HTMLDivElement>, "ref"> & React.RefAttributes<HTMLDivElement>>;
-    Overlay: React.ForwardRefExoticComponent<Omit<_base_ui_react.DialogBackdropProps & React.RefAttributes<HTMLDivElement>, "ref"> & React.RefAttributes<HTMLDivElement>>;
-    Trigger: Dialog.Trigger;
-    Portal: typeof Portal;
-    Handle: React.ForwardRefExoticComponent<Omit<React.DetailedHTMLProps<React.HTMLAttributes<HTMLDivElement>, HTMLDivElement>, "ref"> & {
-        preventCycle?: boolean | undefined;
-    } & React.RefAttributes<HTMLDivElement>>;
-    Close: React.ForwardRefExoticComponent<_base_ui_react.DialogCloseProps & React.RefAttributes<HTMLButtonElement>>;
-    Title: React.ForwardRefExoticComponent<_base_ui_react.DialogTitleProps & React.RefAttributes<HTMLParagraphElement>>;
-    Description: React.ForwardRefExoticComponent<_base_ui_react.DialogDescriptionProps & React.RefAttributes<HTMLParagraphElement>>;
+  Root: typeof Root;
+  NestedRoot: typeof NestedRoot;
+  Content: React.ForwardRefExoticComponent<Omit<_base_ui_react0.DialogPopupProps & React.RefAttributes<HTMLDivElement>, "ref"> & React.RefAttributes<HTMLDivElement>>;
+  Overlay: React.ForwardRefExoticComponent<Omit<_base_ui_react0.DialogBackdropProps & React.RefAttributes<HTMLDivElement>, "ref"> & React.RefAttributes<HTMLDivElement>>;
+  Trigger: Dialog.Trigger;
+  Portal: typeof Portal;
+  Handle: React.ForwardRefExoticComponent<Omit<React.DetailedHTMLProps<React.HTMLAttributes<HTMLDivElement>, HTMLDivElement>, "ref"> & {
+    preventCycle?: boolean;
+  } & React.RefAttributes<HTMLDivElement>>;
+  Close: React.ForwardRefExoticComponent<_base_ui_react0.DialogCloseProps & React.RefAttributes<HTMLButtonElement>>;
+  Title: React.ForwardRefExoticComponent<_base_ui_react0.DialogTitleProps & React.RefAttributes<HTMLParagraphElement>>;
+  Description: React.ForwardRefExoticComponent<_base_ui_react0.DialogDescriptionProps & React.RefAttributes<HTMLParagraphElement>>;
 };
-
-export { Content, type ContentProps, type DialogProps, Drawer, Handle, type HandleProps, NestedRoot, Overlay, Portal, Root, type WithFadeFromProps, type WithoutFadeFromProps };
+//#endregion
+export { Content, ContentProps, DialogProps, Drawer, Handle, HandleProps, NestedRoot, Overlay, Portal, Root, WithFadeFromProps, WithoutFadeFromProps };
+//# sourceMappingURL=index.d.mts.map

package/dist/index.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.mts","names":[],"sources":["../src/context.ts","../src/index.tsx"],"sourcesContent":[],"mappings":";;;;;;KAIY,gBAAA,GAAmB,KAAA,CAAM,WAAW;;;;;;UC6B/B,iBAAA;;AD7BjB;;;;EC6BiB,UAAA,EAAA,CAAA,MAAA,GAAiB,MAAA,CAAA,EAAA;EAajB;AAUjB;;EA0CmB,aAAA,EAAA,MAAA;;AAqCL,UAzFG,oBAAA,CAyFH;EAQT;;;AAEL;;EAEE,UAAA,CAAA,EAAA,CAAA,MAAA,GAAA,MAAA,CAAA,EAAA;EACA,aAAA,CAAA,EAAA,KAAA;;AAEW,KA9FD,WAAA,GA8FC;EACX,eAAA,CAAA,EAAA,MAAA,GAAA,MAAA,GAAA,IAAA;EACA,kBAAA,CAAA,EAAA,CAAA,SAAA,EAAA,MAAA,GAAA,MAAA,GAAA,IAAA,EAAA,GAAA,IAAA;EACA,QAAA,CAAA,EA9FW,KAAA,CAAM,SA8FjB;EACA,IAAA,CAAA,EAAA,OAAA;EACA;;;;;EAKoB,cAAA,CAAA,EAAA,MAAA;EACpB;;;EAGA,YAAA,CAAA,EAAA,OAAA;EACA,YAAA,CAAA,EAAA,CAAA,IAAA,EAAA,OAAA,EAAA,GAAA,IAAA;EACA,qBAAA,CAAA,EAAA,OAAA;EACA;;;;EAIA,yBAAA,CAAA,EAAA,OAAA;EACA;;;;EAGY,iBAAA,CAAA,EAAA,MAAA;EAAA;AAyuBd;;EAAoB,KAAA,CAAA,EAAA,OAAA;EAAA;;;;EAAA,UAAA,CAAA,EAAA,OAAA;EAAA;AAwCpB;AAIA;;;EAAoB,WAAA,CAAA,EAAA,OAAA;EAAA,MAAA,CAAA,EAAA,CAAA,KAAA,EAl2BD,gBAk2BC,EAAA,iBAAA,EAAA,MAAA,EAAA,GAAA,IAAA;EAAA,SAAA,CAAA,EAAA,CAAA,KAAA,EAj2BE,gBAi2BF,EAAA,IAAA,EAAA,OAAA,EAAA,GAAA,IAAA;EAAA;;;AAmJpB;EAOa,KAAA,CAAA,EAAA,OA6GX;EA7GiB,MAAA,CAAA,EAAA,OAAA;EAAA,OAAA,CAAA,EAAA,GAAA,GAAA,IAAA;EAAA;;;;;EAAA;;AAiHnB;;EAEE,WAAA,CAAA,EAAA,OAAA;EACM;;;;EAiCH,oBAAW,CAAA,EAAA,OACP;EAGO;AAOhB;;;;;;;;;;;;cAvnCc;;;;;;;;KAQT,oBAAoB;iBAET,IAAA;QACR;;;UAGE;aACG;;;;;;;;;mBASM;sBACG;;;;;;;;;;;;;;;GAenB,cAAW,kBAAA,CAAA,GAAA,CAAA;cAyuBD,SAAO,KAAA,CAAA,0BAAA,KAoClB,eAAA,CApCkB,mBAAA,GAAA,KAAA,CAAA,cAAA,0BAAA,KAAA,CAAA,cAAA;KAwCR,YAAA,GAAe,KAAA,CAAM,gCACxB,MAAA,CAAgB;cAGZ,SAAO,KAAA,CAAA,0BAAA,KA+IlB,eAAA,CA/IkB,gBAAA,GAAA,KAAA,CAAA,cAAA,0BAAA,KAAA,CAAA,cAAA;KAmJR,WAAA,GAAc,KAAA,CAAM;;;cAOnB,QAAM,KAAA,CAAA,0BAAA,KAAA,KAAA,CAAA,kBAAA,KAAA,CAAA,eAAA,iBAAA;;;iBAiHH,UAAA;;;QAGR;;GAEL,cAAW,kBAAA,CAAA,GAAA,CAAA;KA+BT,WAAA,GAAc,KAAA,CAAM,gCAChB,MAAA,CAAgB;iBAGT,MAAA,QAAc,cAAW,kBAAA,CAAA,GAAA,CAAA;cAO5B"}