1.0.1 • Published 5 years ago

react-png-flipcard v1.0.1

Weekly downloads
6
License
MIT
Repository
github
Last release
5 years ago

Install

Use in bash CLI:

$ npm install --save react-png-flipcard

Showcase

Edit react-png-flipcard

Example on CodeSandbox

Website use Example

npm.io

React Plug-N'-Go Flipcard

Renders a card that provides animation to transition between its front and back JSX. The animation is activated on Hover.

NPM JavaScript Style Guide

Instructions

  1. literally, just plug and go.
  2. import FlipCard from "react-png-flipcard";
  3. declare the component and pass the required props (front, back, direction, height, width) look below for more details.
  4. style front and back as you wish using the frontClass and backClass props.

Features

  1. Nice animation transition between front and back of the card.

Props

PropsFunctionalityDefaultData Type
frontthis props receive JSX to be rendered on the front of the card. Look down for examples on how to do it.Front hereJSX
backthis props receive JSX to be rendered on the back of the card. Look down for examples on how to do it.back hereJSX
widthWidth of the card300number
heightheight of the card300number
directionflip direction"horizontal"string
flipSpeedSpeef of flip animation, in ms600msnumber (ms)
stylestyle object to customize the cardNAobject
containerClassCSS class to style the cardNAcss class
manualBoolean that set animation to be on action (for example on click) this is good to be managed by a stateNAboolean
flipBoolean state that keeps track of wether card is flipped or notFalseboolean
frontStylestyle object to customize the front of the cardNAobject
backStylestyle object to customize the back of the cardNAobject
frontClassCSS class to style the front of the cardNAcss class
backClassCSS class to style the back of the cardNAcss class
marginNumber to set marginNAnumber

Usage

For React.js version ^16.8

Uses React Hooks

import FlipCard from 'react-png-flipcard';

For React.js version ^15.0.0

Uses React Classes to handle state

Pending...

Example

<FlipCard
  front={
    <div className="CardContent">
      <img
        src="https://images.unsplash.com/photo-1501509497947-782640bc1412?ixlib=rb-1.2.1&ixid=eyJhcHBfaWQiOjEyMDd9&auto=format&fit=crop&w=1050&q=80"
        alt="Miami"
        className="CardImage"
      />
      <h3>Miami</h3>
      <div className="HoverInfo" onClick={() => setFlip(true)}>
        <p style={{ margin: 5 }}>Click here to learn more</p>
        <i className="fas fa-arrow-right" style={{ marginTop: 7 }} />
      </div>
    </div>
  }
  back={
    <div className="CardContent">
      <ul style={{ margin: 15, marginLeft: 5 }}>
        <li>Miami, officially the City of Miami</li>
        <li>
          is the cultural, economic and financial center of South Florida.
        </li>
        <li>
          Miami is the seat of Miami-Dade County, the most populous county in
          Florida.
        </li>
      </ul>
      <div
        className="HoverInfo"
        onClick={() => setFlip(false)}
        style={{ marginLeft: 15 }}
      >
        <p style={{ margin: 5 }}>Go back</p>
        <i className="fas fa-arrow-left" style={{ marginTop: 7 }} />
      </div>
    </div>
  }
  backClass={backClass}
  frontClass={frontClass}
  margin={20}
  width={300}
  height={300}
  borderRadius={50}
  direction="horizontal"
  manual
  flip={flip}
/>

Pending

  • Support for react older versions

License

MIT © jorgebaralt

1.0.1

5 years ago

1.0.0

5 years ago

0.4.0

5 years ago

0.3.0

5 years ago

0.2.0

5 years ago

0.1.0

5 years ago