@niibase/bottom-sheet-manager 1.1.0 → 1.3.0

package/src/types.ts

@@ -11,143 +11,158 @@ export type SheetReturnValue<Id extends SheetIds> = Sheets[Id]["returnValue"];
 type AnimationConfigs = WithSpringConfig | WithTimingConfig;
 
 export interface SheetProps<Id extends SheetIds = SheetIds> {
-    readonly id: SheetID<Id>;
-    readonly payload: SheetPayload<Id>;
-    readonly context: string;
+  readonly id: SheetID<Id>;
+  readonly payload: SheetPayload<Id>;
+  readonly context: string;
 }
 
 export interface SheetDefinition<Payload = never, ReturnValue = never> {
-    payload: Payload;
-    returnValue: ReturnValue;
+  payload: Payload;
+  returnValue: ReturnValue;
 }
 
+/**
+ * Defines how sheets behave when a new sheet is opened.
+ *
+ * - `switch`: Closes current sheet and shows new one. Previous sheet is
+ *   restored when new one closes.
+ *
+ * - `replace`: Closes current sheet and opens new one. Previous sheet is
+ *   removed from stack (not restored on close).
+ *
+ * - `push`: (experimental) Stacks new sheet on top. Previous sheet remains visible underneath.
+ */
+export type StackBehavior = "switch" | "replace" | "push";
+
 export interface BottomSheetInstance<Id extends SheetIds = SheetIds> {
-    /**
-     * Close the bottom sheet.
-     * @param args
-     */
-    readonly close: (
-        ...args: SheetReturnValue<Id> extends never
-            ? [
-                  options?: {
-                      /**
-                       * Snap animation configs.
-                       */
-                      animationConfigs?: AnimationConfigs;
-                  },
-              ]
-            : [
-                  options: {
-                      /**
-                       * Return some data to the caller on closing the `BottomSheet`.
-                       */
-                      value: SheetReturnValue<Id>;
-
-                      /**
-                       * Snap animation configs.
-                       */
-                      animationConfigs?: AnimationConfigs;
-                  },
-              ]
-    ) => void;
-
-    /**
-     * Snap to the maximum provided point from `snapPoints`.
-     * @param animationConfigs Snap animation configs.
-     */
-    readonly expand: (animationConfigs?: AnimationConfigs) => void;
-
-    /**
-     * Snap to the minimum provided point from `snapPoints`.
-     * @param animationConfigs Snap animation configs.
-     */
-    readonly collapse: (animationConfigs?: AnimationConfigs) => void;
-
-    /**
-     * Snap to one of the provided points from `snapPoints`.
-     * @param index Snap point index.
-     * @param animationConfigs Snap animation configs.
-     */
-    readonly snapToIndex: (index: number, animationConfigs?: AnimationConfigs) => void;
-
-    /**
-     * Snap to a position out of provided  `snapPoints`.
-     * @param position Position in pixel or percentage.
-     * @param animationConfigs Snap animation configs.
-     */
-    readonly snapToPosition: (
-        position: string | number,
-        animationConfigs?: AnimationConfigs,
-    ) => void;
+  /**
+   * Close the bottom sheet.
+   * @param args
+   */
+  readonly close: (
+    ...args: SheetReturnValue<Id> extends never
+      ? [
+          options?: {
+            /**
+             * Snap animation configs.
+             */
+            animationConfigs?: AnimationConfigs;
+          },
+        ]
+      : [
+          options: {
+            /**
+             * Return some data to the caller on closing the `BottomSheet`.
+             */
+            value: SheetReturnValue<Id>;
+
+            /**
+             * Snap animation configs.
+             */
+            animationConfigs?: AnimationConfigs;
+          },
+        ]
+  ) => void;
+
+  /**
+   * Snap to the maximum provided point from `snapPoints`.
+   * @param animationConfigs Snap animation configs.
+   */
+  readonly expand: (animationConfigs?: AnimationConfigs) => void;
+
+  /**
+   * Snap to the minimum provided point from `snapPoints`.
+   * @param animationConfigs Snap animation configs.
+   */
+  readonly collapse: (animationConfigs?: AnimationConfigs) => void;
+
+  /**
+   * Snap to one of the provided points from `snapPoints`.
+   * @param index Snap point index.
+   * @param animationConfigs Snap animation configs.
+   */
+  readonly snapToIndex: (index: number, animationConfigs?: AnimationConfigs) => void;
+
+  /**
+   * Snap to a position out of provided  `snapPoints`.
+   * @param position Position in pixel or percentage.
+   * @param animationConfigs Snap animation configs.
+   */
+  readonly snapToPosition: (
+    position: string | number,
+    animationConfigs?: AnimationConfigs,
+  ) => void;
 }
 
 export type BottomSheetProps = Omit<
-    RNBottomSheetProps,
-    "children" | "onClose" | "animatedIndex" | "topInset"
+  RNBottomSheetProps,
+  "children" | "onClose"
 > & {
-    /**
-     * ID of the `BottomSheet`.
-     */
-    id?: SheetID<SheetIds>;
-
-    /**
-     * Content of the `BottomSheet`.
-     */
-    children: React.ReactNode;
-
-    /**
-     * When set to true, `BottomSheet` is closed when the hardware back button is pressed.
-     * @default true
-     */
-    hardwareBackPressToClose?: boolean;
-
-    /**
-     * Callback when the sheet close.
-     *
-     * @type () => void;
-     */
-    onClose?: (data?: any) => void;
-
-    /**
-     * Event called before sheets is visible.
-     * @param data Payload of the sheet if any.
-     * @type () => void;
-     */
-    onBeforeShow?: (data?: any) => void;
-
-    /**
-     * Can click through the sheet to the underlying view.
-     * @default false
-     */
-    clickThrough?: boolean;
-
-    /**
-     * Opacity of the sheet's overlay.
-     * @default 0.45
-     */
-    opacity?: number;
-
-    /**
-     * Defines the stack behavior when modal mounts. (experimental)
-     * @default "switch"
-     */
-    stackBehavior?: "push" | "replace" | "switch";
-
-    /**
-     * Whether the bottom sheet edge to edge.
-     * @default false
-     */
-    fullScreen?: boolean;
-
-    /**
-     * Whether the bottom sheet is an iOS modal sheet type of animation.
-     * @default false
-     */
-    iosModalSheetTypeOfAnimation?: boolean;
-
-    className?: string;
-    handleIndicatorClassName?: string;
-    backgroundClassName?: string;
-    containerClassName?: string;
-    handleClassName?: string;
+  /**
+   * ID of the `BottomSheet`.
+   */
+  id?: SheetID<SheetIds>;
+
+  /**
+   * Content of the `BottomSheet`.
+   */
+  children: React.ReactNode;
+
+  /**
+   * When set to true, `BottomSheet` is closed when the hardware back button is pressed.
+   * @default true
+   */
+  hardwareBackPressToClose?: boolean;
+
+  /**
+   * Callback when the sheet close.
+   *
+   * @type () => any;
+   * @returns The data returned by the sheet to be returned when closed.
+   */
+  onClose?: (data?: unknown) => unknown;
+
+  /**
+   * Event called before sheets is visible.
+   * @param data Payload of the sheet if any.
+   * @type () => void;
+   */
+  onBeforeShow?: (data?: unknown) => void;
+
+  /**
+   * Can click through the sheet to the underlying view.
+   * @default false
+   */
+  clickThrough?: boolean;
+
+  /**
+   * Opacity of the sheet's overlay.
+   * @default 0.45
+   */
+  opacity?: number;
+
+  /**
+   * Defines the stack behavior when sheets are opened.
+   *
+   * - `switch`: (default) Dismisses the current sheet before showing the new one.
+   * - `replace`: Swaps the current sheet's content with smooth crossfade animation.
+   * - `push`: (experimental) Pushes new sheet on top, creating a navigable stack.
+   *
+   * @default "switch"
+   */
+  stackBehavior?: StackBehavior;
+
+  /**
+   * Whether the bottom sheet is an iOS 18 modal sheet type of animation.
+   * When enabled at snap point 90%, the content behind the sheet scales down and gets a
+   * border radius, similar to iOS 18 system sheets.
+   * @default false
+   */
+  iosModalSheetTypeOfAnimation?: boolean;
+
+  className?: string;
+  handleIndicatorClassName?: string;
+  backgroundClassName?: string;
+  containerClassName?: string;
+  handleClassName?: string;
 };