@heroku/react-hk-components

React HK Components

Reusable React components. A sister library of ember-hk-components.

Assumptions

Usage of these components assumes you are using the Purple3 CSS framework and Malibu.

Usage

Installation

yarn add @heroku/react-hk-components

Components

See react-hk-components.herokuapp.com for a complete list of components that are available.

Development

Installation

• git clone https://github.com/heroku/react-hk-components
• cd react-hk-components
• yarn

Running

• yarn storybook
• Visit your app at http://localhost:9001.

Local Usage in Another Application

The demo app is useful for developing this addon, but it can often be helpful to consume your version of this addon in another application either to more easily develop your changes or to validate that your changes work as you expect. You can use your local version of react-hk-components in another application that consumes it via yarn's link command.

# in your react-hk-components directory
$ yarn link

# in your consuming app directory
$ yarn link @heroku/react-hk-components

Now, when you make changes in your copy of react-hk-components those changes will be reflected in the consuming application.

Demo app

This repo can be deployed to Heroku as a demo app using Storybook.

heroku create
# ensure that heroku installs the dev dependency storybook
heroku config:set NPM_CONFIG_PRODUCTION=false
git push heroku master