react-instagram-stories 1.0.5 → 1.1.1

package/README.md

@@ -5,6 +5,22 @@ A high-performance, fully customizable Instagram-style Stories component for Rea
 [![NPM Version](https://img.shields.io/npm/v/react-instagram-stories.svg)](https://www.npmjs.com/package/react-instagram-stories)
 [![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)
 
+## Preview
+
+<p align="center">
+  <img src="public/screenshots/demo.gif" alt="React Instagram Stories — live demo" width="320" />
+</p>
+
+<p align="center">
+  <img src="public/screenshots/avatar-list.png" alt="Avatar list with story rings" width="100%" />
+</p>
+
+<p align="center">
+  <img src="public/screenshots/story-viewer.png" alt="Story viewer — image story" width="32%" />
+  &nbsp;&nbsp;
+  <img src="public/screenshots/story-poll.png" alt="Story viewer — interactive poll" width="32%" />
+</p>
+
 ## Features
 
 - **Multiple Content Types**: Images, videos (with audio), text, and fully custom components
@@ -14,11 +30,14 @@ A high-performance, fully customizable Instagram-style Stories component for Rea
 - **Keyboard Navigation**: Full keyboard support for accessibility
 - **TypeScript**: Complete type definitions included
 - **Accessible**: ARIA labels and keyboard navigation
+- **Tailwind CSS Support**: Customize every sub-element via `classNames` prop with Tailwind or custom CSS classes
+- **3D Cube Transition**: Instagram-style 3D cube drag transition when switching between users
+- **Story Resume**: Dragging back to a previous user resumes their story from where you left off
 - **Lightweight**: ~30 KB with zero runtime dependencies
 - **No Router Required**: Works with native browser history API
 - **URL Navigation**: Built-in query parameter support (`?user=userId&story=storyId`)
 - **Auto Progress**: Smart progress bar that pauses during video buffering
-- **Smooth Transitions**: Beautiful animations between stories and users
+- **Smooth Transitions**: 3D cube drag transitions between users, smooth animations between stories
 
 ## Installation
 
@@ -37,8 +56,8 @@ pnpm add react-instagram-stories
 ### Simple Usage (Recommended)
 
 ```tsx
-import { Stories, demoUsers } from 'react-instagram-stories';
-import 'react-instagram-stories/styles.css';
+import { Stories, demoUsers } from "react-instagram-stories";
+import "react-instagram-stories/styles.css";
 
 function App() {
   return <Stories users={demoUsers} />;
@@ -52,8 +71,13 @@ That's it! Click on any avatar to open the story viewer. The URL automatically u
 ### Using Separate Components
 
 ```tsx
-import { AvatarList, StoryViewer, demoUsers, navigateWithParams } from 'react-instagram-stories';
-import 'react-instagram-stories/styles.css';
+import {
+  AvatarList,
+  StoryViewer,
+  demoUsers,
+  navigateWithParams,
+} from "react-instagram-stories";
+import "react-instagram-stories/styles.css";
 
 function App() {
   const handleAvatarClick = (userIndex: number) => {
@@ -76,20 +100,20 @@ function App() {
 
 The StoryViewer supports URL-based navigation using query parameters with **user ID** and **story ID**:
 
-| URL | Result |
-|-----|--------|
-| `?user=user-travel&story=travel-1` | Opens Travel user's first story |
-| `?user=user-polls&story=poll-1` | Opens Interactive user's poll story |
-| `?user=user-launch&story=launch-2` | Opens Events user's second story |
-| No query params | Viewer stays closed |
+| URL                                | Result                              |
+| ---------------------------------- | ----------------------------------- |
+| `?user=user-travel&story=travel-1` | Opens Travel user's first story     |
+| `?user=user-polls&story=poll-1`    | Opens Interactive user's poll story |
+| `?user=user-launch&story=launch-2` | Opens Events user's second story    |
+| No query params                    | Viewer stays closed                 |
 
 ### Navigation Helpers
 
 ```tsx
-import { navigateWithParams, clearQueryParams } from 'react-instagram-stories';
+import { navigateWithParams, clearQueryParams } from "react-instagram-stories";
 
 // Open story viewer with user ID and story ID
-navigateWithParams({ user: 'user-travel', story: 'travel-1' });
+navigateWithParams({ user: "user-travel", story: "travel-1" });
 
 // Close story viewer (clear params)
 clearQueryParams();
@@ -102,20 +126,22 @@ clearQueryParams();
 The all-in-one component with avatar list and story viewer.
 
 ```tsx
-import { Stories } from 'react-instagram-stories';
+import { Stories } from "react-instagram-stories";
 
-<Stories users={myUsers} />
+<Stories users={myUsers} />;
 ```
 
-| Prop | Type | Default | Description |
-|------|------|---------|-------------|
-| `users` | `User[]` | **required** | Array of user objects with their stories |
+| Prop         | Type                | Default      | Description                                                      |
+| ------------ | ------------------- | ------------ | ---------------------------------------------------------------- |
+| `users`      | `User[]`            | **required** | Array of user objects with their stories                         |
+| `classNames` | `StoriesClassNames` | -            | Object to customize sub-element CSS classes (Tailwind or custom) |
 
 ### `<StoryViewer />` Component
 
 The story viewer component. Supports two modes:
 
 #### Query Param Mode (Default)
+
 When `isOpen` is not provided, reads from URL query params:
 
 ```tsx
@@ -123,6 +149,7 @@ When `isOpen` is not provided, reads from URL query params:
 ```
 
 #### Controlled Mode
+
 When `isOpen` is provided, you control the viewer state:
 
 ```tsx
@@ -131,19 +158,20 @@ When `isOpen` is provided, you control the viewer state:
   isOpen={true}
   initialUserIndex={0}
   initialStoryIndex={0}
-  onClose={() => console.log('closed')}
+  onClose={() => console.log("closed")}
   onStoryChange={(userIndex, storyIndex) => console.log(userIndex, storyIndex)}
 />
 ```
 
-| Prop | Type | Default | Description |
-|------|------|---------|-------------|
-| `users` | `User[]` | **required** | Array of user objects |
-| `isOpen` | `boolean` | - | Controls viewer visibility (enables controlled mode) |
-| `initialUserIndex` | `number` | `0` | Starting user index |
-| `initialStoryIndex` | `number` | `0` | Starting story index |
-| `onClose` | `() => void` | - | Called when viewer closes |
-| `onStoryChange` | `(userIndex, storyIndex) => void` | - | Called when story changes |
+| Prop                | Type                              | Default      | Description                                                      |
+| ------------------- | --------------------------------- | ------------ | ---------------------------------------------------------------- |
+| `users`             | `User[]`                          | **required** | Array of user objects                                            |
+| `isOpen`            | `boolean`                         | -            | Controls viewer visibility (enables controlled mode)             |
+| `initialUserIndex`  | `number`                          | `0`          | Starting user index                                              |
+| `initialStoryIndex` | `number`                          | `0`          | Starting story index                                             |
+| `onClose`           | `() => void`                      | -            | Called when viewer closes                                        |
+| `onStoryChange`     | `(userIndex, storyIndex) => void` | -            | Called when story changes                                        |
+| `classNames`        | `StoryViewerClassNames`           | -            | Object to customize sub-element CSS classes (Tailwind or custom) |
 
 ### `<AvatarList />` Component
 
@@ -156,10 +184,11 @@ The horizontal scrollable avatar list.
 />
 ```
 
-| Prop | Type | Description |
-|------|------|-------------|
-| `users` | `User[]` | Array of user objects |
-| `onAvatarClick` | `(userIndex: number) => void` | Called when avatar is clicked |
+| Prop            | Type                          | Description                                                      |
+| --------------- | ----------------------------- | ---------------------------------------------------------------- |
+| `users`         | `User[]`                      | Array of user objects                                            |
+| `onAvatarClick` | `(userIndex: number) => void` | Called when avatar is clicked                                    |
+| `classNames`    | `AvatarListClassNames`        | Object to customize sub-element CSS classes (Tailwind or custom) |
 
 ## Story Types
 
@@ -187,6 +216,7 @@ The horizontal scrollable avatar list.
 ```
 
 **Features:**
+
 - Audio enabled by default
 - Progress bar pauses during buffering
 - Auto-detects video duration
@@ -234,6 +264,7 @@ const MyCustomStory: React.FC<StoryItemControls> = ({
 ```
 
 **Control Methods Available:**
+
 - `pause()` - Pause the story timer
 - `resume()` - Resume the story timer
 - `next()` - Go to next story
@@ -247,10 +278,14 @@ Build interactive experiences! Here are examples included in `demoUsers`:
 ### Poll Component
 
 ```tsx
-const PollComponent: React.FC<StoryItemControls> = ({ pause, resume, next }) => {
+const PollComponent: React.FC<StoryItemControls> = ({
+  pause,
+  resume,
+  next,
+}) => {
   const [selected, setSelected] = React.useState<number | null>(null);
   const [votes, setVotes] = React.useState([42, 28, 18, 12]);
-  const options = ['React', 'Vue', 'Angular', 'Svelte'];
+  const options = ["React", "Vue", "Angular", "Svelte"];
 
   React.useEffect(() => {
     pause(); // Pause timer during interaction
@@ -272,14 +307,16 @@ const PollComponent: React.FC<StoryItemControls> = ({ pause, resume, next }) =>
   const total = votes.reduce((a, b) => a + b, 0);
 
   return (
-    <div style={{
-      display: 'flex',
-      flexDirection: 'column',
-      height: '100%',
-      background: 'linear-gradient(135deg, #667eea 0%, #764ba2 100%)',
-      padding: '20px'
-    }}>
-      <h2 style={{ color: 'white', marginBottom: '20px' }}>
+    <div
+      style={{
+        display: "flex",
+        flexDirection: "column",
+        height: "100%",
+        background: "linear-gradient(135deg, #667eea 0%, #764ba2 100%)",
+        padding: "20px",
+      }}
+    >
+      <h2 style={{ color: "white", marginBottom: "20px" }}>
         What's your favorite framework?
       </h2>
       {options.map((option, index) => (
@@ -288,17 +325,18 @@ const PollComponent: React.FC<StoryItemControls> = ({ pause, resume, next }) =>
           onClick={() => handleVote(index)}
           disabled={selected !== null}
           style={{
-            margin: '8px 0',
-            padding: '15px',
-            background: selected === index ? '#4CAF50' : 'rgba(255,255,255,0.2)',
-            color: 'white',
-            border: 'none',
-            borderRadius: '12px',
-            fontSize: '16px',
-            cursor: selected !== null ? 'default' : 'pointer'
+            margin: "8px 0",
+            padding: "15px",
+            background:
+              selected === index ? "#4CAF50" : "rgba(255,255,255,0.2)",
+            color: "white",
+            border: "none",
+            borderRadius: "12px",
+            fontSize: "16px",
+            cursor: selected !== null ? "default" : "pointer",
           }}
         >
-          <div style={{ display: 'flex', justifyContent: 'space-between' }}>
+          <div style={{ display: "flex", justifyContent: "space-between" }}>
             <span>{option}</span>
             {selected !== null && (
               <span>{((votes[index] / total) * 100).toFixed(0)}%</span>
@@ -318,7 +356,26 @@ const PollComponent: React.FC<StoryItemControls> = ({ pause, resume, next }) =>
 Import the default styles:
 
 ```tsx
-import 'react-instagram-stories/styles.css';
+import "react-instagram-stories/styles.css";
+```
+
+**With Tailwind CSS**: Import the library styles **before** your Tailwind CSS so that utility classes can override them:
+
+```css
+/* Your global CSS file */
+@import "react-instagram-stories/styles.css";
+
+@tailwind base;
+@tailwind components;
+@tailwind utilities;
+```
+
+Or in JS, import the library CSS before your app's CSS:
+
+```tsx
+// main.tsx
+import "react-instagram-stories/styles.css"; // first
+import "./index.css"; // your Tailwind CSS — after
 ```
 
 Override with custom CSS:
@@ -350,13 +407,60 @@ Override with custom CSS:
 }
 ```
 
+## Customization with classNames
+
+Every component accepts a `classNames` prop for fine-grained styling using Tailwind CSS or custom CSS classes. The prop is a typed object that maps to specific sub-elements.
+
+```tsx
+<Stories
+  users={users}
+  classNames={{
+    avatarList: {
+      root: "bg-gray-900 p-4",
+      avatar: { ring: "border-pink-500", username: "text-xs text-gray-400" },
+    },
+    storyViewer: {
+      overlay: "bg-black/90",
+      closeButton: "hover:text-gray-300",
+      progressBars: {
+        bar: { fill: "bg-gradient-to-r from-pink-500 to-purple-500" },
+      },
+    },
+  }}
+/>
+```
+
+You can also pass `classNames` directly to `StoryViewer` or `AvatarList` when using them separately:
+
+```tsx
+<AvatarList
+  users={users}
+  onAvatarClick={handleClick}
+  classNames={{
+    root: "bg-gray-900 p-4",
+    avatar: { ring: "border-pink-500", username: "text-xs text-gray-400" },
+  }}
+/>
+
+<StoryViewer
+  users={users}
+  classNames={{
+    overlay: "bg-black/90",
+    closeButton: "hover:text-gray-300",
+    progressBars: { bar: { fill: "bg-gradient-to-r from-pink-500 to-purple-500" } },
+  }}
+/>
+```
+
+All `classNames` types are exported from the package. See the [TypeScript Types](#typescript-types) section for the full list.
+
 ## Advanced Usage
 
 ### Using Demo Data
 
 ```tsx
-import { Stories, demoUsers } from 'react-instagram-stories';
-import 'react-instagram-stories/styles.css';
+import { Stories, demoUsers } from "react-instagram-stories";
+import "react-instagram-stories/styles.css";
 
 function App() {
   return <Stories users={demoUsers} />;
@@ -368,7 +472,7 @@ The `demoUsers` includes examples of all story types including interactive polls
 ### Generate Demo Users
 
 ```tsx
-import { generateDemoUsers } from 'react-instagram-stories';
+import { generateDemoUsers } from "react-instagram-stories";
 
 const users = generateDemoUsers(10); // 10 users with random stories
 ```
@@ -376,39 +480,39 @@ const users = generateDemoUsers(10); // 10 users with random stories
 ### Create Custom Stories
 
 ```tsx
-import type { User } from 'react-instagram-stories';
+import type { User } from "react-instagram-stories";
 
 const myUsers: User[] = [
   {
-    id: '1',
-    username: 'johndoe',
-    avatarUrl: 'https://example.com/avatar.jpg',
+    id: "1",
+    username: "johndoe",
+    avatarUrl: "https://example.com/avatar.jpg",
     hasUnreadStories: true, // Shows ring around avatar
     stories: [
       {
-        id: 'story-1',
-        type: 'image',
-        src: 'https://example.com/photo.jpg',
-        alt: 'Beach sunset',
+        id: "story-1",
+        type: "image",
+        src: "https://example.com/photo.jpg",
+        alt: "Beach sunset",
         duration: 5000,
       },
       {
-        id: 'story-2',
-        type: 'video',
-        src: 'https://example.com/video.mp4',
+        id: "story-2",
+        type: "video",
+        src: "https://example.com/video.mp4",
         // duration auto-detected
       },
       {
-        id: 'story-3',
-        type: 'text',
-        text: 'Hello from my story!',
-        backgroundColor: '#FF6B6B',
-        textColor: '#FFFFFF',
+        id: "story-3",
+        type: "text",
+        text: "Hello from my story!",
+        backgroundColor: "#FF6B6B",
+        textColor: "#FFFFFF",
         duration: 5000,
       },
       {
-        id: 'story-4',
-        type: 'custom_component',
+        id: "story-4",
+        type: "custom_component",
         component: MyPollComponent,
         duration: 10000,
       },
@@ -422,8 +526,8 @@ const myUsers: User[] = [
 If you don't want URL navigation, use controlled mode:
 
 ```tsx
-import { useState } from 'react';
-import { AvatarList, StoryViewer } from 'react-instagram-stories';
+import { useState } from "react";
+import { AvatarList, StoryViewer } from "react-instagram-stories";
 
 function App() {
   const [viewerState, setViewerState] = useState({
@@ -435,7 +539,9 @@ function App() {
     <>
       <AvatarList
         users={myUsers}
-        onAvatarClick={(index) => setViewerState({ isOpen: true, userIndex: index })}
+        onAvatarClick={(index) =>
+          setViewerState({ isOpen: true, userIndex: index })
+        }
       />
       <StoryViewer
         users={myUsers}
@@ -458,6 +564,7 @@ function App() {
 
 - **Tap Left/Right** - Navigate stories
 - **Swipe Left/Right** - Change users
+- **Drag Left/Right** - 3D cube transition between users (peek at next/previous user, snaps on release)
 - **Swipe Down** - Close
 - **Hold/Hover** - Pause
 
@@ -472,11 +579,18 @@ import type {
   ImageStoryItem,
   VideoStoryItem,
   TextStoryItem,
-  CustomComponentStoryItem
-} from 'react-instagram-stories';
+  CustomComponentStoryItem,
+  StoriesClassNames,
+  StoryViewerClassNames,
+  AvatarListClassNames,
+  AvatarClassNames,
+  StoryProgressBarsClassNames,
+  ProgressBarClassNames,
+  StoryItemClassNames,
+} from "react-instagram-stories";
 
 // Core Types
-type StoryItemType = 'image' | 'video' | 'text' | 'custom_component';
+type StoryItemType = "image" | "video" | "text" | "custom_component";
 
 interface StoryItemControls {
   pause: () => void;
@@ -493,19 +607,58 @@ interface User {
   stories: StoryItem[];
   hasUnreadStories?: boolean;
 }
+
+// ClassNames Types (for Tailwind / custom CSS customization)
+interface StoriesClassNames {
+  avatarList?: AvatarListClassNames;
+  storyViewer?: StoryViewerClassNames;
+}
+
+interface AvatarListClassNames {
+  root?: string;
+  avatar?: AvatarClassNames;
+}
+
+interface AvatarClassNames {
+  root?: string;
+  ring?: string;
+  image?: string;
+  username?: string;
+}
+
+interface StoryViewerClassNames {
+  overlay?: string;
+  closeButton?: string;
+  progressBars?: StoryProgressBarsClassNames;
+  storyItem?: StoryItemClassNames;
+}
+
+interface StoryProgressBarsClassNames {
+  root?: string;
+  bar?: ProgressBarClassNames;
+}
+
+interface ProgressBarClassNames {
+  root?: string;
+  fill?: string;
+}
+
+interface StoryItemClassNames {
+  root?: string;
+}
 ```
 
 ## Package Exports
 
 ```tsx
 // Components
-import { Stories, StoryViewer, AvatarList } from 'react-instagram-stories';
+import { Stories, StoryViewer, AvatarList } from "react-instagram-stories";
 
 // Navigation helpers
-import { navigateWithParams, clearQueryParams } from 'react-instagram-stories';
+import { navigateWithParams, clearQueryParams } from "react-instagram-stories";
 
 // Demo data
-import { demoUsers, generateDemoUsers } from 'react-instagram-stories';
+import { demoUsers, generateDemoUsers } from "react-instagram-stories";
 
 // Types
 import type {
@@ -516,18 +669,25 @@ import type {
   ImageStoryItem,
   VideoStoryItem,
   TextStoryItem,
-  CustomComponentStoryItem
-} from 'react-instagram-stories';
+  CustomComponentStoryItem,
+  StoriesClassNames,
+  StoryViewerClassNames,
+  AvatarListClassNames,
+  AvatarClassNames,
+  StoryProgressBarsClassNames,
+  ProgressBarClassNames,
+  StoryItemClassNames,
+} from "react-instagram-stories";
 
 // Styles
-import 'react-instagram-stories/styles.css';
+import "react-instagram-stories/styles.css";
 ```
 
 ## Performance
 
 - **Bundle Size**: ~30 KB (minified)
 - **Gzipped**: ~10 KB
-- **Zero Runtime Dependencies**
+- **Zero Runtime Dependencies**: No production dependencies at all (framer-motion and tailwindcss-animate are dev-only)
 - **Smart Preloading**: Preloads adjacent stories
 - **Optimized Rendering**: Uses React.memo
 - **Video Buffering Detection**: Pauses progress during buffering
@@ -536,6 +696,7 @@ import 'react-instagram-stories/styles.css';
 
 - React 18+
 - TypeScript
+- CSS 3D Transforms (cube transition between users)
 - Native Browser History API (no router needed)
 - tsup (bundler)