@drivexstudio/animations 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 drivex-studio
+
+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,125 @@
+# @drivexstudio/animations
+
+Creative text animations and micro-interaction components for React, built on GSAP, Framer Motion, and Lenis.
+
+## Install
+
+```bash
+npm install @drivexstudio/animations
+```
+
+`react` and `react-dom` (>=18) are peer dependencies — install them in your app if they aren't already.
+
+## Setup
+
+Some components depend on context providers being mounted above them in your app tree. Wrap your root layout once:
+
+```jsx
+import {
+  LenisProvider,
+  PreloaderProvider,
+  PageTransitionProvider,
+  PageEnterProvider
+} from '@drivexstudio/animations';
+
+export default function RootLayout({ children }) {
+  return (
+    <LenisProvider>
+      <PreloaderProvider>
+        <PageTransitionProvider>
+          <PageEnterProvider>
+            {children}
+          </PageEnterProvider>
+        </PageTransitionProvider>
+      </PreloaderProvider>
+    </LenisProvider>
+  );
+}
+```
+
+You only need the providers for the features you actually use — e.g. skip `PreloaderProvider` if you don't render `<Preloader />`.
+
+## Usage
+
+### Scramble text on hover
+
+```jsx
+import { ScrambleText } from '@drivexstudio/animations';
+
+<ScrambleText triggerOnHover duration={0.6}>
+  Hover me
+</ScrambleText>
+```
+
+### Scroll-triggered headline
+
+```jsx
+import { ScrollAnimatedHeadline } from '@drivexstudio/animations';
+
+<ScrollAnimatedHeadline
+  headline={{ text: 'Built for motion', level: 'h1' }}
+/>
+```
+
+### Animated button / link
+
+```jsx
+import { AnimatedButton, AnimatedLink } from '@drivexstudio/animations';
+
+<AnimatedButton onClick={handleClick}>Get started</AnimatedButton>
+<AnimatedLink href="/work">View work</AnimatedLink>
+```
+
+### Scramble multiple elements together
+
+```jsx
+import { ScrambleGroup, ScrambleText } from '@drivexstudio/animations';
+
+<ScrambleGroup stagger={0.08}>
+  <ScrambleText>First line</ScrambleText>
+  <ScrambleText>Second line</ScrambleText>
+</ScrambleGroup>
+```
+
+## Components
+
+| Export | Description |
+|---|---|
+| `ScrambleText` | Character-scramble reveal/hover text effect |
+| `ScrambleGroup` / `useScrambleGroup` | Staggers multiple `ScrambleText` children on scroll or manually |
+| `AnimatedHeadline` | Headline with entrance/scroll animation |
+| `ScrollAnimatedHeadline` | Scroll-triggered wrapper around `AnimatedHeadline` |
+| `AnimatedButton` | Button with built-in micro-interaction |
+| `AnimatedLink` | Link with built-in micro-interaction |
+| `AnimatedProse` / `AnimatedProseContext` / `stagger` | Paragraph-level staggered text reveal |
+| `AnimatedSubtext` | Subtext reveal animation |
+| `AnimatedText` | Generic staggered text animation |
+| `Preloader` | Page preloader, driven by `PreloaderProvider` |
+
+## Providers & hooks
+
+| Export | Description |
+|---|---|
+| `LenisProvider` / `useLenis` / `scrollToTop` / `getLenis` / `setCssScrollLocked` / `getCssScrollLocked` | Smooth-scroll setup and helpers |
+| `PreloaderProvider` / `usePreloader` | Preloader phase state |
+| `PageTransitionProvider` / `usePageTransitionContext` / `usePageTransition` | Route-transition phase state |
+| `PageEnterProvider` / `usePageEnterContext` / `usePageEnter` | Coordinates staggered "page enter" animations across components |
+| `useIdleGSAP` | Runs a GSAP setup callback during browser idle time |
+| `useAsciiDelay` | Small timing utility |
+| `useDualLayerScramble` | Low-level hook behind `ScrambleText`'s dual-layer effect |
+
+## Low-level utilities
+
+`gsap`, `useGSAP`, `ScrollTrigger`, `SplitText`, `ScrambleTextPlugin`, `cx`, `cva`, and `easingDefinitionToFunction` are re-exported for consumers who want to build custom animations with the same GSAP plugin setup this package uses internally.
+
+## Development
+
+```bash
+npm install
+npm run build   # bundles packages/index.js -> dist/ (ESM + CJS)
+npm run dev      # watch mode
+```
+
+## License
+
+MIT

package/package.json

@@ -0,0 +1,57 @@
+{
+  "name": "@drivexstudio/animations",
+  "version": "1.0.0",
+  "description": "Creative text animations and micro-interaction components for React",
+  "type": "module",
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.js",
+  "exports": {
+    ".": {
+      "import": "./dist/index.js",
+      "require": "./dist/index.cjs"
+    },
+    "./package.json": "./package.json"
+  },
+  "files": [
+    "dist"
+  ],
+  "sideEffects": false,
+  "scripts": {
+    "build": "tsup",
+    "dev": "tsup --watch"
+  },
+  "peerDependencies": {
+    "react": ">=18",
+    "react-dom": ">=18"
+  },
+  "dependencies": {
+    "@gsap/react": "^2.1.1",
+    "@radix-ui/react-slot": "^1.1.0",
+    "class-variance-authority": "^0.7.1",
+    "framer-motion": "^11.0.0",
+    "gsap": "^3.12.5",
+    "lenis": "^1.1.13"
+  },
+  "devDependencies": {
+    "react": "^18.3.1",
+    "react-dom": "^18.3.1",
+    "tsup": "^8.0.0"
+  },
+  "keywords": [
+    "react",
+    "animation",
+    "gsap",
+    "scroll",
+    "lenis",
+    "micro-interaction",
+    "ui"
+  ],
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/drivex-studio/components-library"
+  },
+  "publishConfig": {
+    "access": "public"
+  }
+}