Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/skn437/skn-framer-types
A Simple Type Definition Extension Library For Framer Motion 11
https://github.com/skn437/skn-framer-types
animation bun framer-motion library nextjs nodejs react types typescript
Last synced: about 2 months ago
JSON representation
A Simple Type Definition Extension Library For Framer Motion 11
- Host: GitHub
- URL: https://github.com/skn437/skn-framer-types
- Owner: skn437
- License: mit
- Created: 2024-06-20T09:55:21.000Z (6 months ago)
- Default Branch: master
- Last Pushed: 2024-09-16T21:07:01.000Z (4 months ago)
- Last Synced: 2024-11-05T01:06:43.896Z (about 2 months ago)
- Topics: animation, bun, framer-motion, library, nextjs, nodejs, react, types, typescript
- Language: Shell
- Homepage:
- Size: 30.3 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# SKN Framer Motion Type Extension Library
> TypeScript React
[](https://www.npmjs.com/package/@best-skn/framer-types) [](https://opensource.org/license/mit)
ย
## **_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
- ๐ Minimum [react](https://www.npmjs.com/package/react) Version: `18.3.1`
- ๐ Minimum [@types/react](https://www.npmjs.com/package/@types/react) Version: `18.3.3`
- ๐ Minimum [react-dom](https://www.npmjs.com/package/react-dom) Version: `18.3.1`
- ๐ Minimum [@types/react-dom](https://www.npmjs.com/package/@types/react-dom) Version: `18.3.0`
- ๐ Minimum [next](https://www.npmjs.com/package/next) Version: `14.2.3`
- ๐ Minimum [framer-motion](https://www.npmjs.com/package/framer-motion) Version: `11.2.11`
ย
## **_Complementary Libraries:_**
- [@best-skn/react-types](https://www.npmjs.com/package/@best-skn/react-types)
- [@best-skn/next-types](https://www.npmjs.com/package/@best-skn/next-types)
ย
## **_Usage:_**
### To install the package, type the following in console
> ```zsh
> 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
> ```typescript
> 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
> ```typescript
> import type { Anime } from "framer-motion";
>
> type key = "container" | "box"; // * Create variant names here
>
> export const anime: Anime = {
> //* 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
> ```typescript jsx
> "use client"
>
> import { motion } from "framer-motion";
> import { anime } from "./anime.ts";
>
> const HomeComponent: React.FC = () => {
> return (
> variants={anime.container} //* Put your variants here
> initial="hidden"
> animate="visible"
> >
> variants={anime.box} //* Put your variants here
> initial="hidden"
> animate="visible"
> >
>
>
>
> );
> };
>
> export default HomeComponent;
> ```
#### **_`CsxAnime` Type:_**
##### (1) React CSX styles with motion style compatibility in separate file
> ```typescript
> import type { CsxAnime } from "framer-motion";
>
> type key = "container" | "box"; // * Create class names here
>
> export const csx: CsxAnime = {
> //* 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
> ```typescript jsx
> "use client"
>
> import { motion } from "framer-motion";
> import { csx } from "./csx.ts";
>
> const HomeComponent: React.FC = () => {
> return (
>
>
>
>
>
> );
> };
>
> 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