react-view-transition-swiper 0.2.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Chris Lu Yi
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/dist/index.d.mts

@@ -0,0 +1,57 @@
+import * as react from 'react';
+import { ReactNode } from 'react';
+
+interface SlideItem {
+    id: string;
+    content: ReactNode;
+}
+type DragPermission = "all" | "left" | "right" | "up" | "down" | "none";
+interface SlideOptions {
+    keepDom?: boolean;
+    animate?: boolean;
+    drag?: DragPermission;
+}
+interface NavOptions {
+    /** Skip the view transition and swap instantly. Default: false */
+    instant?: boolean;
+}
+type SwipeDeckErrorCode = "NAV_MISSING_ELEMENT" | "NAV_ELEMENT_NOT_VISIBLE" | "POINTER_CAPTURE_FAILED" | "POINTER_RELEASE_FAILED";
+interface SwipeDeckError {
+    code: SwipeDeckErrorCode;
+    message: string;
+    /** Extra context: cur, delta, next, retries, element ids, etc. */
+    detail?: Record<string, unknown>;
+}
+interface SwipeDeckHandle {
+    readonly currentIndex: number;
+    readonly currentSlides: SlideItem[];
+    addSlide: (slide: SlideItem, options?: SlideOptions) => void;
+    removeSlide: (id: string, options?: Pick<SlideOptions, "animate">) => void;
+    removeSlides: (ids: string[], options?: Pick<SlideOptions, "animate">) => void;
+    goTo: (index: number, options?: NavOptions) => void;
+    next: (options?: NavOptions) => void;
+    prev: (options?: NavOptions) => void;
+    setPeek: (index: number | null) => void;
+}
+interface SwipeDeckProps {
+    width?: number;
+    showDots?: boolean;
+    fade?: boolean;
+    dimOnDrag?: boolean;
+    maxDragRatio?: number;
+    dragDisabled?: boolean;
+    keyboardDisabled?: boolean;
+    /** Drag and nav direction. "y" uses scroll-boundary detection so card
+     *  content can still scroll freely; nav only triggers when the scroll
+     *  hits the top/bottom edge and the user continues pulling. Default: "x" */
+    navAxis?: "x" | "y";
+    dragDelayMs?: number;
+    /** Duration of the view transition and gesture fly-out in ms. Default: 360 */
+    transitionMs?: number;
+    onSlideChange?: (index: number) => void;
+    onError?: (error: SwipeDeckError) => void;
+    className?: string;
+}
+declare const SwipeDeck: react.ForwardRefExoticComponent<SwipeDeckProps & react.RefAttributes<SwipeDeckHandle>>;
+
+export { type DragPermission, type NavOptions, type SlideItem, type SlideOptions, type SwipeDeckError, type SwipeDeckErrorCode, type SwipeDeckHandle, type SwipeDeckProps, SwipeDeck as default };

package/dist/index.d.ts

@@ -0,0 +1,57 @@
+import * as react from 'react';
+import { ReactNode } from 'react';
+
+interface SlideItem {
+    id: string;
+    content: ReactNode;
+}
+type DragPermission = "all" | "left" | "right" | "up" | "down" | "none";
+interface SlideOptions {
+    keepDom?: boolean;
+    animate?: boolean;
+    drag?: DragPermission;
+}
+interface NavOptions {
+    /** Skip the view transition and swap instantly. Default: false */
+    instant?: boolean;
+}
+type SwipeDeckErrorCode = "NAV_MISSING_ELEMENT" | "NAV_ELEMENT_NOT_VISIBLE" | "POINTER_CAPTURE_FAILED" | "POINTER_RELEASE_FAILED";
+interface SwipeDeckError {
+    code: SwipeDeckErrorCode;
+    message: string;
+    /** Extra context: cur, delta, next, retries, element ids, etc. */
+    detail?: Record<string, unknown>;
+}
+interface SwipeDeckHandle {
+    readonly currentIndex: number;
+    readonly currentSlides: SlideItem[];
+    addSlide: (slide: SlideItem, options?: SlideOptions) => void;
+    removeSlide: (id: string, options?: Pick<SlideOptions, "animate">) => void;
+    removeSlides: (ids: string[], options?: Pick<SlideOptions, "animate">) => void;
+    goTo: (index: number, options?: NavOptions) => void;
+    next: (options?: NavOptions) => void;
+    prev: (options?: NavOptions) => void;
+    setPeek: (index: number | null) => void;
+}
+interface SwipeDeckProps {
+    width?: number;
+    showDots?: boolean;
+    fade?: boolean;
+    dimOnDrag?: boolean;
+    maxDragRatio?: number;
+    dragDisabled?: boolean;
+    keyboardDisabled?: boolean;
+    /** Drag and nav direction. "y" uses scroll-boundary detection so card
+     *  content can still scroll freely; nav only triggers when the scroll
+     *  hits the top/bottom edge and the user continues pulling. Default: "x" */
+    navAxis?: "x" | "y";
+    dragDelayMs?: number;
+    /** Duration of the view transition and gesture fly-out in ms. Default: 360 */
+    transitionMs?: number;
+    onSlideChange?: (index: number) => void;
+    onError?: (error: SwipeDeckError) => void;
+    className?: string;
+}
+declare const SwipeDeck: react.ForwardRefExoticComponent<SwipeDeckProps & react.RefAttributes<SwipeDeckHandle>>;
+
+export { type DragPermission, type NavOptions, type SlideItem, type SlideOptions, type SwipeDeckError, type SwipeDeckErrorCode, type SwipeDeckHandle, type SwipeDeckProps, SwipeDeck as default };