npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@best-skn/framer-types

v1.0.2

Published

A Simple Type Definition Extension Library For Framer Motion 11

Downloads

63

Readme

SKN Framer Motion Type Extension Library

TypeScript React

NPM Version MIT License

 

Introduction:

This is a simple TypeScript Type Extension Library for Framer Motion 11, React 18 & also for Next.js 14

I made this library so that I can use it in all of my Next.js 14 projects without writing the same codes over and over again

 

Details:

Anime Type

  • It provides total intellisense of framer motion styles in separate files to be used as variants
  • This type will help to de-clutter your jsx/tsx components because you can create variants outside motion components and later use it inside the motion components
  • This type will only work on motion components like motion.div, motion.span, motion.main etc. or any other custom motion components created with motion() function
  • For usage instruction, see Usage section

CsxAnime Type

  • It provides total intellisense of react csx styles in separate files and ensures compatibility with framer motion styles as well
  • This type will help to de-clutter your jsx/tsx components because you can create csx styles outside motion components
  • This type will only work on motion components like motion.div, motion.span, motion.main etc. or any other custom motion components created with motion() function
  • For usage instruction, see Usage section

 

Use Case:

  • React
  • Next.js

 

Requirements:

This library has peer dependency for React & React DOM of minimum 18.3.1. It may or may not work on 19.x

It has peer dependency for Framer Motion of minimum 11.2.11. It may or may not work on 12.x

This library is intended to be used in Next.js of minimum 14.2.3. It may or may not work on 15.x

 

Complementary Libraries:

 

Usage:

To install the package, type the following in console

npm add -D @best-skn/framer-types
#or
yarn add -D @best-skn/framer-types
#or
pnpm add -D @best-skn/framer-types
#or
bun add -D @best-skn/framer-types

Create a directory called types in the root location of your project, and create a file called motion.d.ts, then do this

import "@best-skn/framer-types";

Check your tsconfig.json if includes property has **/*.ts, **/*.tsx otherwise the type definition file may not work

Now Inside your Next.js 14 Project, use the package like this (Just an example)

Anime Type:

(1) Motion style variants in separate file
import type { Anime } from "framer-motion";

type key = "container" | "box"; // * Create variant names here

export const anime: Anime<key> = {
  //* You'll get total intellisense for `variant` names
  container: {
    //* You'll get intellisense for motion styles inside `hidden` or `visible` properties
    hidden: {
      opacity: 0,
      //* other motion styles here...
    },
    visible: {
      opacity: 1,
      //* other motion styles here...
    },
  },
  box: {
    hidden: {
      opacity: 0,
      //* other motion styles here...
    },
    visible: {
      opacity: 1,
      //* other motion styles here...
    },
  },
};
(2) Import & use the created variants inside motion components in Next.js
"use client"

import { motion } from "framer-motion";
import { anime } from "./anime.ts";

const HomeComponent: React.FC<unknown> = () => {
  return (
    <motion.div
      variants={anime.container} //* Put your variants here
      initial="hidden"
      animate="visible"
    >
      <motion.div
        variants={anime.box} //* Put your variants here
        initial="hidden"
        animate="visible"
      >
        <!-- other elements here... -->
      </motion.div>
    </motion.div>
  );
};

export default HomeComponent;

CsxAnime Type:

(1) React CSX styles with motion style compatibility in separate file
import type { CsxAnime } from "framer-motion";

type key = "container" | "box"; // * Create class names here

export const csx: CsxAnime<key> = {
  //* You'll get total intellisense for `class` names
  container: {
    //* You'll get intellisense for react css styles here
    fontWeight: "bolder",
    //* css styles here...

    //* framer motion related styles
    scaleX: "",
  },
  box: {
    fontWeight: "bolder",
    //* css styles here...

    //* framer motion related styles
    scaleX: "",
  },
};
(2) Import & use the created style inside motion components in Next.js
"use client"

import { motion } from "framer-motion";
import { csx } from "./csx.ts";

const HomeComponent: React.FC<unknown> = () => {
  return (
    <motion.div className={csx.container}>
      <motion.div className={csx.box}>
        <!-- other elements here... -->
      </motion.div>
    </motion.div>
  );
};

export default HomeComponent;

 

Dedicated To:

  • 👩‍⚕️Tanjila Hasan Trina: The long lost love of my life. The course of nature separated us from our paths and put us in separate places far away from each other. But no matter how separated we are right now, each and every moment of mine is only dedicated to you. We may not see each other in this lifetime as it seems but I will find you again in the next life. I just want to say: 世界は残酷だ それでも君を愛すよ
  • 💯My Parents: The greatest treasures of my life ever.

 

License:

Copyright (C) 2024 SKN Shukhan

Licensed under the MIT License