Getting Started

Formstone is designed to be implemented easily without negatively impacting an existing project. Scripts are wrapped in self-executing closures and styles are individually name spaced to avoid collisions.

Deploy

The first step is to deploy the package, either by downloading the package from GitHub or using NPM. Formstone can be deployed and updated via the command line with NPM:

npm install formstone

Implement

The core.js file is a main dependency for all JavaScript based components:

<script src="/components/formstone/dist/js/core.js"></script>

Components can be implemented by including the required files and dependencies directly, or by hooking into a current build scripts:

<link href="/components/formstone/dist/css/component.css" rel="stylesheet">
<script src="/components/formstone/dist/js/component.js"></script>

AMD Support

Formstone JavaScript component is compatible with module loaders like RequireJS or webpack:

// loads plugin and dependencies
require('formstone/js/background.js'); 

Customize

When customizing any component, best practice is to deploy the production files as provided then implement and extend the component's properties in local scripts and styles. Themes are the preferred way to customize Formstone components. Read more about theming components.

Contribute

Find a bug? Have an idea for new functionality? Check out the Contributing Guide.

Support

Bug reports and feature requests can be filed on the GitHub issue tracker.