elm-form-builder

Form widgets and validation used for internal projects.

HTML elements are styled using Bulma.

Currently supports the following form elements:

• Age
• Checkbox
• Date
• Email
• Phone
• Radio
• Select
• Text

Examples

We recommend checking out the examples (code) to get a feel for how it works.

Run the following commands to test out the examples locally:

yarn install
yarn start

Setup

yarn install

CI

yarn elm-format --validate src tests
yarn elm-review
yarn elm-test
yarn elm make

Doing a release

When your changes are ready to go (merged into main) it's time to do a release.

1. elm bump: yarn run elm bump. Fix any issues this finds and accept recommended version suggestion.
2. Check elm publish works: yarn run elm publish. It will fail when it gets to the github tag stage but might show some other suggestions / issues.
3. Update the example site: yarn build:pages.
4. Create a branch (possibly with your new changes) and push to github. Create a PR and have it reviewed before merging.
5. Once branch merged, checkout main (so you not on your branch anymore).
6. Create a tag with the appropriate version (eg. 4.0.0) on github. Running yarn run elm publish will give you the commands to run. For the description, try to add something meaningful like "added nullable option to required".
7. Run elm publish for real.

It should take about 20 minutes for the updated package to be live on elm packages, but you can use the new version in your repos straight away.