MCPcopy Index your code
hub / github.com/Mutesa-Cedric/react-swift-reveal

github.com/Mutesa-Cedric/react-swift-reveal @v1.3.0

Chat with this repo
repository ↗ · DeepWiki ↗ · release v1.3.0 ↗ · + Follow
84 symbols 155 edges 48 files 0 documented · 0%
What it actually does AI analysis from the code graph — generated when you open this
loading…
README

react-swift-reveal

react-swift-reveal is a React component library and animation framework for animating elements as they enter the viewport.

for more, check the documentation

Installation

with npm:

npm install react-swift-reveal@latest

with yarn:

yarn add react-swift-reveal@latest

with pnpm:

pnpm add react-swift-reveal@latest

Usage

import { Fade } from "react-swift-reveal";

const App = () => {
  return (
    <Fade>
      <h1>hello world</h1>
    </Fade>
  );
};

or

import { Fade } from "react-swift-reveal";

const App = () => {
  return (
    <Fade>
      <MyComponent /> //component to be animated
    </Fade>
  );
};

with next.js app directory

"use client";

import { Fade } from "react-swift-reveal";

export default function Home() {
  return (
    <Fade>
      <h1>hello world</h1>
    </Fade>
  );
}

Available Animations

  • Fade
  • Bounce
  • Slide
  • Zoom
  • Flip
  • Rotate
  • Roll
  • LightSpeed

Simple animations

  • Flash
  • Jello
  • Pulse
  • RubberBand
  • Shake
  • Swing
  • Tada
  • Wobble
  • HeadShake
  • Pop
  • Spin
  • Jump

Support

If you like this project, please consider supporting it by giving it a star.

Extension points exported contracts — how you extend this code

Window (Interface)
(no doc)
library/custom.d.ts
EventListenerOptions (Interface)
(no doc)
library/src/types/index.ts
AnimationDemoProps (Interface)
(no doc)
apps/docs/components/AnimationDemo.tsx
InOutEffect (Interface)
(no doc)
library/src/types/index.ts
RevealProps (Interface)
(no doc)
library/src/types/index.ts
IAnimationProps (Interface)
(no doc)
library/src/types/index.ts
RevealState (Interface)
(no doc)
library/src/lib/Base.tsx

Core symbols most depended-on inside this repo

wrapper
called by 20
library/src/HOC/wrapper.tsx
animation
called by 20
library/src/lib/defaultConfigs.ts
getTop
called by 3
library/src/lib/Base.tsx
unlisten
called by 3
library/src/lib/Base.tsx
getInitialCollapseStyle
called by 2
library/src/lib/Base.tsx
getDimensionValue
called by 2
library/src/lib/Base.tsx
getChild
called by 2
library/src/lib/Base.tsx
disableSsr
called by 2
library/src/lib/defaultConfigs.ts

Shape

Function 67
Interface 17

Languages

TypeScript100%

Modules by API surface

library/src/lib/Base.tsx12 symbols
library/src/lib/defaultConfigs.ts10 symbols
library/src/types/index.ts4 symbols
library/src/animations/complex/Zoom.ts3 symbols
library/src/animations/complex/Slide.ts3 symbols
library/src/animations/complex/Rotate.ts3 symbols
library/src/animations/complex/Roll.ts3 symbols
library/src/animations/complex/LightSpeed.ts3 symbols
library/src/animations/complex/Flip.ts3 symbols
library/src/animations/complex/Fade.ts3 symbols
library/src/animations/complex/Bounce.ts3 symbols
apps/docs/components/AnimationDemo.tsx3 symbols

For agents

$ claude mcp add react-swift-reveal \
  -- python -m otcore.mcp_server <graph>

⬇ download graph artifact

Ask about this repo answers extend the page