react-magic-card
v2.0.7
Published
React Component library for images gallery using the framer motion animation.
Downloads
31
Maintainers
Readme
react-magic-card
This is the framer motion components, that support images gallery.
Installation
npm install react-magic-card framer-motion
Usage Guide
import { MagicCircle } from 'react-magic-card'
function MyComponent() {
const images = [
{
src: '/src.jpeg',
alt: 'alt'
}
]
return (
<MagicCircle
images={images}
width={100}
height={100}
radius={100}
controller={100}
start={1}
delay={100}
/>
)
}
Common Properties
| Property | Meaning | | --------------------- | ----------------------------------------------------------------- | | images (required) | array of images and objects containing the src and alt properties | | start (required) | index number of the array of start scale position | | width (required) | width of the single image | | height (required) | height of the single image | | controller (required) | controller size is add to the size of the component | | delay | delay of the animation firing interval | | offsetIndex | add an offset to the index of the components and images | | reverseIndex | order the change the overlap of zindex default true | | loading | loading attribute of img element in html | | initialFadeRange | range of fade animation after page loaded | | initialTransTime | transition time of fade animation after page loaded | | className | className of the component | | classImages | className of the images | | classImageSelect | className of the select image | | classImageUnique | className of the index number is assigned to the end | | animate | object in the animation property | | initial | object in the animation property | | transition | object in the transition property | | pickTransition | object in the transition property | | pickProperty | object in the pick property |
MagicCircle Properties
| Property | Meaning | | ----------------- | ----------------------------------------------- | | radius (required) | radius of the circle | | dynamic | dynamic or static for rotation the default true |
MagicStraight Properties
| Property | Meaning | | ------------- | --------------------------------------- | | vertical | vertical or horizontal the default true | | margin | spacing of the between images | | selectOffsetX | X-axis position | | selectOffsetY | Y-axis position |
Animation Object
| Property | Meaning | | ------------- | ------------------------------------- | | scale | scaling of the images | | opacity | opacity or transparency of the images | | rotateX | X-axis rotation of the images | | rotateY | Y-axis rotation of the images | | rotateZ | Z-axis rotation of the images | | selectScale | scaling of the selected image | | selectOpacity | opacity of the selected image | | selectRotateX | X-axis rotation of the selected image | | selectRotateY | Y-axis rotation of the selected image | | selectRotateZ | Z-axis rotation of the selected image |
Transition Object
It is Inherits framer motion transition object other than intera.
PickProperty Object
| Property | Meaning | | --------- | --------------------------------------------------------- | | classPick | className of the pick image | | white | white or black for background the default true | | alpha | background transparency of a number between 0 ~ 1 | | blur | blur intensity of a number between 1 ~ 20 a preferred | | scale | scale of the pick image | | offset | offset of an appearance position from the center position |
License
The MIT License.