A Stimulusjs controller to help with displaying progress when a user is filling out forms
npm install stimulus-form-progress-barA Stimulusjs controller to help with displaying progress when a user is filling out forms.
Checkout the demo
You must have StimulusJS already installed.
```
yarn add stimulus-form-progress-bar
or
``
npm install stimulus-form-progress-bar
or use directly from unpkg:
``
Next you have to initialize StimulusJS and import the Stimulus Form Progress Bar
`
import { Application } from "stimulus"
import { definitionsFromContext } from "stimulus/webpack-helpers"
const application = Application.start()
const context = require.context("controllers", true, /_controller\.js$/)
application.load(definitionsFromContext(context))
import { ProgressBar } from 'stimulus-form-progress-bar'
application.register('progress-bar', ProgressBar)
`
Add the relevant markup to get started. Note this example uses TailwindCSS.
Note you need a bar target and each input element except radio buttons need a required attribute.
1. Add data-controller to the parent div
2. Add data-progress-bar-target='bar' to your progress bar with a width of 0
`
Start
Finish
`data-action='progress-bar#updateProgressBar'
3. Next, add a required attribute to the input element followed by
`
`
Checkout the example in the docs/index.html file
There are three configuration options that you can use to change your progress bar behaviour.
data-progress-bar-width-value='30' will set the initial progress bar to 30%
data-progress-bar-increment-value='30' will decide how much the bar should be incremented. In this case, it's 30%. Default is calculated based on number of inputs in the form
data-progress-bar-min-width-value='30'` will set the minimum width of the bar
Bug reports and pull requests are welcome on GitHub at https://github.com/williamkennedy/stimulus-form-progress-bar. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.
This package is available as open source under the terms of the MIT License.