leveluptuts / motion-elements

Elements and Components built with Framer Motion

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

@leveluptuts/motion-elements

Motion Elements

Mr Wave On

Demo

Install

yarn add @leveluptuts/motion-elements

Usage

The Syntax

import { Accordion } from '@leveluptuts/motion-elements';

...
<Accordion>
	<p>Another example</p>
</Accordion>
...

More options

import React, { useState } from 'react';
import { Accordion } from '@leveluptuts/motion-elements';

const App = () => {
	const [isToggled, setToggle] = useState(true);
	return (
		<div>
			<button onClick={() => setToggle(prev => !prev)}>Toggle</button>
			<Accordion isToggled={isToggled} useButton={false}>
				<p>Some text.</p>
			</Accordion>
		</div>
	)

API

Accordion

The parent of an array of components

Prop Type Default Description
children Components An array of React Components
isToggled Boolean OPTIONAL _ The bool that toggles the accordion
useButton Boolean (data) => data OPTIONAL _ if you want to bring your own b, byob if you will

Contributing

yarn yarn start

(in another tab) to run example

cd example yarn yarn start

Prior Art and Inspirations

This lib is just basic wrappers around https://www.framer.com/motion/

About

Elements and Components built with Framer Motion

License:MIT License


Languages

Language:TypeScript 62.2%Language:CSS 34.7%Language:HTML 3.1%