1.0.0 • Published 2 years ago

framer-animate-on-view v1.0.0

Weekly downloads
-
License
MIT
Repository
github
Last release
2 years ago

framer-animate-on-view

made-with-javascript GitHub license JavaScript

> A simple wrapper to Animate React components on View.

Demo

CodeSandbox

  • AnimateOnView component should be wrapped to make that component animate
  • Default object can be imported for simple view animation.
  • Primarily intersection observer concept is used.
  • Totally safe and secure.

Table of contents

Install

node.js:

npm install framer-animate-on-view --save

(Note : If this fails somehow try with npm install animatore-on-view-2 --legacy-peer-deps) (Will not fail if you have react 18)

Usage examples

Refer this for example App : Example app with code

Simple

// Import Module

import { AnimateOnView } from "framer-animate-on-view";

//Component
export default function App() {
  return (
    <div>
      <AnimateOnView tagName="h1">
        Hey, I will Animate on view
      </AnimateOnView>{" "}
      // This component will animate on view
    </div>
  );
}

Props for customisation

Options

Provide these as props on the <AnimateOnView/> component.

NameTypeDefaultRequiredDescription
tagNameStringNonetrueThis will make AnimateOnView component to make the tag based container. For example div,h1,h2, etc.
thresholdnumber0falseNumber between 0 and 1 indicating the percentage that should be visible before triggering. Based on react intersection observer
triggerOncebooleanfalsefalseTo trigger animation once only not on every view. True for once.
tabIndexnumberundefinedfalsetabIndex property for accessibility.
variantsobjectDefault AnimationtrueObject with hidden and visible which animates from hidden to visible props.
classNameclassNamefalsefalseClass for adding styles.
onHoverStartFunctionfalsefalseFunction to track hover start.
onHoverEndFunctionfalsefalseFunction to track hover end.
stylesobjectfalsefalseInline Styles for container.

Authors

Made this component while designing my portfolio. Made more component for reusablitity. As animaton on view in react requires lot of configs, installations. Made this simple component with minimal props.

Refer

  • Framer motion here i.e Only variants object to customise animations more.