red-door v1.0.8

Red Door Components

Common React components shared across The Red Door applications.

How to install

npm install --save red-door

This package also includes all of the styling for the components AND the fonts for all Red Door Applications. I wanted to include the fonts in this package as well so it is easier to manage them from one place. You can do something like this to move the font files wherever you want.

mkdir -p ./pub/res/fonts && cp -r ./node_modules/red-door/styles/fonts ./pub/res/'

This package comes with both sass files (in ./styles/_red-door.scss) and a compiled css version (./red-door.css) to use. If you are using gulp-sass/node-sass, you can add "/node_modules/red-door/styles" to your includePaths.

After you move the fonts over, you can override the $red-door-font-url and make it the path to wherever you moved the fonts. If you are using sass you can do something like this:

/* $red-door-font-url should not end in a "/" - it is automatically added at the end */
$red-door-font-url: "path/to/fonts"; // in this case it could be "res/fonts"
@import "red-door";

There are a couple of assets that may be required in the css (select_arrow.png is one). I created a sass variable $img-base-path which is used to specify the root directory for all assets. You can override this variable the same as the $red-door-font-url.

How to use

Require it in your javascript

var RedDoor = require('red-door');
var LoadSpinner = RedDoor.LoadSpinner;

// ... React stuff <LoadSpinner />

Examples

I am in the process of building examples for all of the shared components. You must build the examples for the to work.

• Open up any of the html files examples/.

We use browserify to actualy make the html examples work. This makes the files in examples/js/ very bulky and hard to read. You can look in the examples/src/ directory for the actual implementation.

I will try to better explain how each component works later