overlapping-cards-scroll 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Brian Ephraim
+
+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/README.md

@@ -0,0 +1,119 @@
+# overlapping-cards-scroll
+
+Reusable overlapping-cards scroll component for React, React Native, and React Native Web.
+
+## Install
+
+```bash
+npm install overlapping-cards-scroll
+```
+
+Peer dependencies:
+
+- `react` `^18 || ^19`
+- `react-dom` `^18 || ^19` (optional)
+- `react-native` `>=0.73` (optional)
+- `react-native-web` `>=0.19` (optional)
+
+## Web Usage
+
+```tsx
+import 'overlapping-cards-scroll/styles.css'
+import {
+  OverlappingCardsScroll,
+  OverlappingCardsScrollFocusTrigger,
+} from 'overlapping-cards-scroll'
+
+export function Example({ cards }) {
+  return (
+    <OverlappingCardsScroll cardHeight={280} showPageDots pageDotsPosition="below">
+      {cards.map((card) => (
+        <article key={card.id}>
+          <h3>{card.title}</h3>
+          <OverlappingCardsScrollFocusTrigger>
+            Make principal
+          </OverlappingCardsScrollFocusTrigger>
+        </article>
+      ))}
+    </OverlappingCardsScroll>
+  )
+}
+```
+
+## React Native Usage
+
+```tsx
+import {
+  OverlappingCardsScrollRN,
+  OverlappingCardsScrollRNFocusTrigger,
+} from 'overlapping-cards-scroll/react-native'
+```
+
+`/react-native` resolves to:
+
+- native build for React Native runtimes
+- web adapter build for non-native runtimes
+
+You can also target explicit builds:
+
+- `overlapping-cards-scroll/react-native/native`
+- `overlapping-cards-scroll/react-native/web`
+
+For web adapter usage, import package styles:
+
+```tsx
+import 'overlapping-cards-scroll/styles.css'
+```
+
+## Props
+
+- `children`: card nodes
+- `cardHeight` (`number | string`, default `300`)
+- `cardWidth` (`number | string`) accepts px number (e.g. `250`) or percent string (e.g. `'50%'`)
+- `cardWidthRatio` (`number`, default `1 / 3`)
+- `basePeek` (`number`, default `64`)
+- `minPeek` (`number`, default `10`)
+- `maxPeek` (`number`, default `84`)
+- `showPageDots` (`boolean`, default `false`) renders clickable page dots
+- `pageDotsPosition` (`'above' | 'below' | 'overlay'`, default `'below'`)
+- `pageDotsOffset` (`number | string`, default `10`) distance from stage
+- `pageDotsBehavior` (`'smooth' | 'auto'`, web only, default `'smooth'`)
+- `snapToCardOnRelease` (`boolean`, default `true`) web/RN-web uses idle + mousemove snap, RN native uses `snapToInterval` on iOS
+- `snapReleaseDelay` (`number`, default `800`) web/RN-web debounce before auto-snap
+- `snapDecelerationRate` (`'normal' | 'fast' | number`, RN native only, default `'normal'`) controls fling feel while snapping
+- `snapDisableIntervalMomentum` (`boolean`, RN native only, default `false`) keep `false` for stronger momentum across multiple cards
+- `focusTransitionDuration` (`number`, default `420`) duration for click-triggered "single swoop" focus transitions
+- `className` (`string`)
+- `ariaLabel` (`string`)
+
+## Local Development
+
+```bash
+npm install
+npm run dev
+```
+
+Vite demos:
+
+- `#basic` foundation demo
+- `#content` rich-content demo
+- `#stress` many-card stress demo
+- `#rnweb` React Native Web demo
+
+Expo development:
+
+```bash
+npm run dev:expo
+```
+
+Build package artifacts:
+
+```bash
+npm run build
+```
+
+Build demo site:
+
+```bash
+npm run build:demo
+```