Skip to content
This repository has been archived by the owner on Oct 19, 2019. It is now read-only.

VisionistInc/react-flipper

Repository files navigation

react-flipper

React 'flipper' component that is agnostic to the height of its tiles, resizing accordingly. No jQuery.

Build Status Greenkeeper badge Commitizen friendly styled with prettier semantic-release

Get Started

  • Clone the repository
$ git clone git@github.com:VisionistInc/react-flipper.git
  • Go into the cloned repository's directory
$ cd react-flipper/
  • Install dependencies
$ yarn install

Usage

class MySuperDuperAwesomeApp extends Component {
  constructor (props) {
    super (props);
    this.state = { isFlipped: false };
  }
  flip = () => {
    this.setState ({ isFlipped: !this.state.isFlipped });
  }
  render () {
    return <div>
      <button onClick={this.flip}>
        Flip!
      </button>
      <Flipper isFlipped={this.state.isFlipped} orientation="horizontal">
        <Front style={{
          minHeight: 250,
          background: '#19489E'
        }}>
          /** PLACE FRONT CONTENT HERE **/
        </Front>
        <Back style={{
          background: '#9E1919',
          minHeight: 400
        }}>
          /** PLACE BACK CONTENT HERE **/
        </Back>
      </Flipper>
    </div>
  }
}

A few things to note:

  1. Both, front and back tiles, have no styles -- styling is completely up to you.
  2. minHeight is not necessary -- each tile will default to 30px; height is adjusted accordingly upon mount.

Running for development

$ npm start

Contributing

Use GitHub to fork this project, make and commit your changes, and then submit a new pull request.

Updating gh-pages

We're just using the dist directory on the gh-pages branch to showcase our demo.

After making your changes, run:

$ npm run build

# !! commit your changes here !!

$ git subtree push --prefix dist origin gh-pages

This updates the bundled code in the dist directory, then you commit the updated source, then push the dist directory to the root of the gh-pages branch.