react-spring-carousel 2.0.19 → 3.0.0-beta-1.0.0

package/.storybook/main.ts

@@ -0,0 +1,17 @@
+import type { StorybookConfig } from "@storybook/react-vite";
+
+const config: StorybookConfig = {
+  stories: ["../src/**/*.mdx", "../src/**/*.stories.@(js|jsx|mjs|ts|tsx)"],
+  addons: [
+    "@storybook/addon-onboarding",
+    "@storybook/addon-links",
+    "@storybook/addon-essentials",
+    "@chromatic-com/storybook",
+    "@storybook/addon-interactions",
+  ],
+  framework: {
+    name: "@storybook/react-vite",
+    options: {},
+  },
+};
+export default config;

package/.storybook/preview.ts

@@ -0,0 +1,15 @@
+import type { Preview } from "@storybook/react";
+import "../src/storybook.global.styles.css";
+
+const preview: Preview = {
+  parameters: {
+    controls: {
+      matchers: {
+        color: /(background|color)$/i,
+        date: /Date$/i,
+      },
+    },
+  },
+};
+
+export default preview;

package/README.md

@@ -1,54 +1,50 @@
-# react-spring-carousel
+# React + TypeScript + Vite
 
-> A performant React carousel component powered by `react-spring` and `@use-gesture`.
+This template provides a minimal setup to get React working in Vite with HMR and some ESLint rules.
 
-[![NPM](https://img.shields.io/npm/v/react-spring-carousel.svg)](https://www.npmjs.com/package/react-spring-carousel) [![NPM](https://img.shields.io/bundlephobia/minzip/react-spring-carousel)](https://img.shields.io/bundlephobia/minzip/react-spring-carousel)
+Currently, two official plugins are available:
 
-## Install
+- [@vitejs/plugin-react](https://github.com/vitejs/vite-plugin-react/blob/main/packages/plugin-react/README.md) uses [Babel](https://babeljs.io/) for Fast Refresh
+- [@vitejs/plugin-react-swc](https://github.com/vitejs/vite-plugin-react-swc) uses [SWC](https://swc.rs/) for Fast Refresh
 
-```bash
-// npm v7.x
-npm install --save react-spring-carousel
-```
-
-```bash
-// npm v6.x or less
-npm install --save react-spring react-spring-carousel
-```
+## Expanding the ESLint configuration
 
-```bash
-yarn add react-spring react-spring-carousel
-```
-
-## Usage
+If you are developing a production application, we recommend updating the configuration to enable type aware lint rules:
 
-```tsx
-import { useSpringCarousel } from 'react-spring-carousel'
+- Configure the top-level `parserOptions` property like this:
 
-const { carouselFragment, slideToPrevItem, slideToNextItem } = useSpringCarousel({
-  items: [
-    {
-      id: 'item-1',
-      renderItem: <div>Item 1</div>,
-    },
-    {
-      id: 'item-2',
-      renderItem: <div>Item 2</div>,
+```js
+export default tseslint.config({
+  languageOptions: {
+    // other options...
+    parserOptions: {
+      project: ['./tsconfig.node.json', './tsconfig.app.json'],
+      tsconfigRootDir: import.meta.dirname,
     },
-  ],
+  },
 })
-
-return (
-  <div>
-    <button onClick={slideToPrevItem}>Prev item</button>
-    <div>{carouselFragment}</div>
-    <button onClick={slideToNextItem}>Next item</button>
-  </div>
-)
 ```
 
-## Official documentation
-
-For a complete overview of the library, please visit the official documentation.
-
-[Visit here](https://react-spring-carousel.emilianobucci.com)
+- Replace `tseslint.configs.recommended` to `tseslint.configs.recommendedTypeChecked` or `tseslint.configs.strictTypeChecked`
+- Optionally add `...tseslint.configs.stylisticTypeChecked`
+- Install [eslint-plugin-react](https://github.com/jsx-eslint/eslint-plugin-react) and update the config:
+
+```js
+// eslint.config.js
+import react from 'eslint-plugin-react'
+
+export default tseslint.config({
+  // Set the react version
+  settings: { react: { version: '18.3' } },
+  plugins: {
+    // Add the react plugin
+    react,
+  },
+  rules: {
+    // other rules...
+    // Enable its recommended rules
+    ...react.configs.recommended.rules,
+    ...react.configs['jsx-runtime'].rules,
+  },
+})
+```

package/eslint.config.js

@@ -0,0 +1,28 @@
+import js from "@eslint/js";
+import globals from "globals";
+import reactHooks from "eslint-plugin-react-hooks";
+import reactRefresh from "eslint-plugin-react-refresh";
+import tseslint from "typescript-eslint";
+
+export default tseslint.config(
+  { ignores: ["dist"] },
+  {
+    extends: [js.configs.recommended, ...tseslint.configs.recommended],
+    files: ["**/*.{ts,tsx}"],
+    languageOptions: {
+      ecmaVersion: 2020,
+      globals: globals.browser,
+    },
+    plugins: {
+      "react-hooks": reactHooks,
+      "react-refresh": reactRefresh,
+    },
+    rules: {
+      ...reactHooks.configs.recommended.rules,
+      "react-refresh/only-export-components": [
+        "warn",
+        { allowConstantExport: true },
+      ],
+    },
+  }
+);

package/index.html

@@ -0,0 +1,13 @@
+<!doctype html>
+<html lang="en">
+  <head>
+    <meta charset="UTF-8" />
+    <link rel="icon" type="image/svg+xml" href="/vite.svg" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+    <title>Vite + React + TS</title>
+  </head>
+  <body>
+    <div id="root"></div>
+    <script type="module" src="/src/main.tsx"></script>
+  </body>
+</html>

package/lib/events.ts

@@ -0,0 +1,39 @@
+import { FullGestureState } from "@use-gesture/react";
+
+export type SlideActionType = "drag" | "click";
+export type SlideDirection = "prev" | "next";
+
+export type OnDrag = Omit<FullGestureState<"drag">, "event"> & {
+  eventName: "onDrag";
+  slideActionType: SlideActionType;
+};
+type OnSlideStartChange = {
+  eventName: "onSlideStartChange";
+  slideDirection: SlideDirection;
+  sliceActionType: SlideActionType;
+  nextItem: {
+    index: number;
+    id: string;
+    startReached: boolean | undefined;
+    endReached: boolean | undefined;
+  };
+};
+type OnSlideChangeComplete = {
+  eventName: "onSlideChangeComplete";
+  slideDirection: SlideDirection;
+  sliceActionType: SlideActionType;
+  currentItem: {
+    index: number;
+    id: string;
+    startReached: boolean | undefined;
+    endReached: boolean | undefined;
+  };
+};
+
+export type SpringCarouselEvents =
+  | OnSlideStartChange
+  | OnSlideChangeComplete
+  | OnDrag;
+export type SpringCarouselEventsEventHandler = (
+  props: SpringCarouselEvents
+) => void;