gatsby-card-flipper v0.3.0

react-card-flipper

This version allows for compatibility with Gatsby. As of right now Scss files are not compiling correctly so they will just need to be copied to your project manually.

A React card flipper component (built with React 16.2.0) that can be triggered by hover or click. Inspired from David Walsh's great tutorial.

Installation

Yarn:

yarn add react-card-flipper

npm:

npm install react-card-flipper --save

Current Browser Support

Initial testing via BrowserStack of a React app that simply renders the card component.

Getting Started

You can import react-card-flipper into your React app. The following is a bare bones example.

Important: The <ReactCardFlipper> component must have two <div> elements, one for the front and one for the back.

import React from 'react';
import ReactDOM from 'react-dom';
import ReactCardFlipper from 'react-card-flipper';

ReactDOM.render(
  <div>
    <ReactCardFlipper>
      <div>
        The cards front content goes here.
      </div>
      <div>
        The cards back content goes here.
      </div>
    </ReactCardFlipper>
  </div>,
  document.getElementById('root')
);

Props and Options

The ReactCardFlipper component has 4 props it accepts that you can use to adjust how your card behaves.

Example:

render() {
  return(
    <div>
      <ReactCardFlipper width="300px" height="550px" behavior="click" levitate={true}>
        <div>
          <h3>Click me to learn more</h3>
        </div>
        <div>
          <p>You Clicked!</p>
        </div>
      </ReactCardFlipper>
    </div>
  )
}

Styling

Out of the box we provide very little styling aside from core styles like transitions to let you shape the design as you see fit. All of the css classes provided for are prefixed with rcf- to avoid any conflicts with existing classes. In most cases you'll only be adding styles to .rcf-front & .rcf-back. All classes available for styling are:

• rcf-container - main container for the component
• rcf-front - front card styling
• rcf-back - back card styling
• rcf-flipper - "flipper" container, controls animation speed, etc.

Development

To get started developing on this project, fork or clone the repo. Then run yarn install

Start the development server

yarn start

Starts the development/test server and polls for changes.

Running EsLint

yarn lint

Lints ReactCardFlipper.js and outputs any warnings or errors.

Running Tests

yarn test

Runs EsLint, and builds the test output.

Running Production Build

yarn build

Compiles a new build in the dist/ folder.