@daformat/react-headless-carousel 1.0.0 → 1.0.1

package/dist/Carousel.d.ts

@@ -0,0 +1,89 @@
+import { type ComponentPropsWithoutRef, type CSSProperties, type RefObject } from "react";
+import type { MaybeNull, MaybeUndefined } from "./utils/maybe.js";
+type ScrollState = {
+    isDragging: boolean;
+    isDispatchingClick: boolean;
+    startX: number;
+    scrollLeft: number;
+    lastX: number;
+    lastTime: number;
+    velocityX: number;
+    animationId: number | null;
+    initialTarget: MaybeNull<EventTarget>;
+    initialPointerPosition: MaybeNull<{
+        x: number;
+        y: number;
+    }>;
+    mouseDirection: number;
+    scrollSnapType: string;
+};
+type ScrollIntoView = (target: HTMLElement, container: HTMLElement, direction: "forwards" | "backwards" | "nearest") => void;
+type CarouselContext = {
+    ref?: RefObject<MaybeNull<HTMLElement>>;
+    setRef: (ref: RefObject<MaybeNull<HTMLElement>>) => void;
+    scrollsBackwards: boolean;
+    scrollsForwards: boolean;
+    setScrollsBackwards: (scrollsBackwards: boolean) => void;
+    setScrollsForwards: (scrollsForwards: boolean) => void;
+    handleScrollToNext: () => void;
+    handleScrollToPrev: () => void;
+    scrollIntoView: ScrollIntoView;
+    remainingForwards?: number;
+    remainingBackwards?: number;
+    setRemainingForwards: (remainingForwards: number) => void;
+    setRemainingBackwards: (remainingBackwards: number) => void;
+    scrollStateRef?: MaybeUndefined<RefObject<ScrollState>>;
+    setScrollStateRef: (state: RefObject<ScrollState>) => void;
+    boundaryOffset?: {
+        x: number;
+        y: number;
+    } | ((root: HTMLElement) => {
+        x: number;
+        y: number;
+    });
+    rootRef: RefObject<MaybeNull<HTMLElement>>;
+    clearAnimation: () => void;
+};
+declare const CarouselContext: import("react").Context<CarouselContext>;
+type CarouselViewportBaseProps = ComponentPropsWithoutRef<"div"> & {
+    scrollSnapType?: CSSProperties["scrollSnapType"];
+};
+type CarouselViewportProps = CarouselViewportBaseProps & ({
+    contentFade?: true;
+    contentFadeSize?: string | number;
+} | {
+    contentFade: false;
+    contentFadeSize?: never;
+});
+export declare const Carousel: {
+    Root: import("react").ForwardRefExoticComponent<{
+        boundaryOffset?: {
+            x: number;
+            y: number;
+        } | ((root: HTMLElement) => {
+            x: number;
+            y: number;
+        });
+    } & Omit<import("react").DetailedHTMLProps<import("react").HTMLAttributes<HTMLDivElement>, HTMLDivElement>, "ref"> & import("react").RefAttributes<HTMLDivElement>>;
+    Viewport: import("react").ForwardRefExoticComponent<CarouselViewportProps & import("react").RefAttributes<HTMLDivElement>>;
+    Content: import("react").ForwardRefExoticComponent<Omit<import("react").DetailedHTMLProps<import("react").HTMLAttributes<HTMLDivElement>, HTMLDivElement>, "ref"> & import("react").RefAttributes<HTMLDivElement>>;
+    Item: import("react").ForwardRefExoticComponent<Omit<import("react").DetailedHTMLProps<import("react").HTMLAttributes<HTMLDivElement>, HTMLDivElement>, "ref"> & {
+        asChild?: boolean;
+    } & import("react").RefAttributes<HTMLElement>>;
+    PrevPage: import("react").ForwardRefExoticComponent<Omit<import("react").DetailedHTMLProps<import("react").ButtonHTMLAttributes<HTMLButtonElement>, HTMLButtonElement>, "ref"> & import("react").RefAttributes<HTMLButtonElement>>;
+    NextPage: import("react").ForwardRefExoticComponent<Omit<import("react").DetailedHTMLProps<import("react").ButtonHTMLAttributes<HTMLButtonElement>, HTMLButtonElement>, "ref"> & import("react").RefAttributes<HTMLButtonElement>>;
+    useCarouselContext: () => CarouselContext;
+    defaultBoundaryOffset: (container: HTMLElement) => {
+        x: number;
+        y: number;
+    };
+    CSS_VARS: Readonly<{
+        fadeSize: "--carousel-fade-size";
+        fadeOffsetBackwards: "--carousel-fade-offset-backwards";
+        fadeOffsetForwards: "--carousel-fade-offset-forwards";
+        overscrollTranslateX: "--carousel-overscroll-translate-x";
+        remainingBackwards: "--carousel-remaining-backwards";
+        remainingForwards: "--carousel-remaining-forwards";
+    }>;
+};
+export {};

package/dist/index.d.ts

@@ -0,0 +1 @@
+export { Carousel } from "./Carousel.js";

package/dist/test/setup.d.ts

@@ -0,0 +1 @@
+import "@testing-library/jest-dom";

package/dist/utils/maybe.d.ts

@@ -0,0 +1,3 @@
+export type Maybe<T> = T | null | undefined;
+export type MaybeNull<T> = T | null;
+export type MaybeUndefined<T> = T | undefined;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@daformat/react-headless-carousel",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "license": "MIT",
   "description": "A react headless carousel component, with no dependencies, supporting drag to scroll, inertia, rubber-banding, snapping and more",
   "keywords": [
@@ -19,21 +19,12 @@
     "type": "git",
     "url": "git+https://github.com/daformat/react-headless-carousel.git"
   },
-  "scripts": {
-    "build": "tsc",
-    "ci": "pnpm build && pnpm format:check && pnpm test",
-    "format": "prettier --write .",
-    "format:check": "prettier --check .",
-    "local-release": "changeset version && changeset publish",
-    "prepublishOnly": "npm run ci",
-    "test": "vitest run"
-  },
   "files": [
     "dist"
   ],
   "type": "module",
   "main": "dist/index.js",
-  "packageManager": "pnpm@10.4.0+sha512.6b849d0787d97f8f4e1f03a9b8ff8f038e79e153d6f11ae539ae7c435ff9e796df6a862c991502695c7f9e8fac8aeafc1ac5a8dab47e36148d183832d886dd52",
+  "types": "dist/index.d.ts",
   "peerDependencies": {
     "react": ">=18"
   },
@@ -49,5 +40,13 @@
     "react-dom": "^18.3.1",
     "typescript": "^6.0.2",
     "vitest": "^4.1.1"
+  },
+  "scripts": {
+    "build": "tsc",
+    "ci": "pnpm build && pnpm format:check && pnpm test",
+    "format": "prettier --write .",
+    "format:check": "prettier --check .",
+    "local-release": "changeset version && changeset publish",
+    "test": "vitest run"
   }
-}
+}