foundry-react v0.2.1

Foundry React

Element studio have compiled a list of super useful components that get reused a lot.

This consists of Foundry React Core (components) and utilities (some useful js helpers).

Getting Started

*This project is not really ready for use.

Installing

npm install foundry-react --save

Example code:

import TextInput as 'foundry-react/core/inputs/TextInput';

The code is compiled to es6+ so if you require es5 then please use a compiler

Documentation

There are a few components in here that are useful, however the documentation isn't quite ready.

For now just any pals that want to use this right now will have to dig through the code to see how it works.

Contributing

Written in typescript

Uses story book to write the components in isolation

npm i && npm start # Installs dependencies and load up story book

npm run build-link # Builds the JS files and links them in your global directory for use in projects. Then use `npm link foundry-react` in your actual project to start using the local version for testing in situ

npm run build #build the JS files

Important for when publish. use npm run build-publish, so that the build files get published first.

License

MIT