The Progress Bar Field for WS Form & PRO

ProgressPRO

This field enables you to add a progress bar to your form. Progress bars can be configured to show:

  • Form progress (Completed required fields)
  • Tab progress
  • Upload progress (When used in conjunction with a file upload field) – View tutorial
  • Custom (Control the progress bar with conditional logic or your own JavaScript)

For forms that have multiple tabs, you can add the progress bar to each tab. The progress bar shows the overall progress of the entire form across all tabs.

Demo

To learn how to add, edit, clone, move, resize, offset, or delete a progress bar field, please click here.

To edit the settings for this field type, click the settings icon on the field itself. Click the ‘Save & Close’ or ‘Save’ button to save your changes. If you do not want to save your changes, you can click the ‘Cancel’ button or click any other form element to close the field settings sidebar.
WS Form - Field Settings Icon

Basic

The basic tab contains settings that the majority of WS Form users will need to control a field. The settings are as follows:

Label

This is the label shown alongside the field. As well as entering a label into this field, you can also double click the label of the field in the editor. You should enter an easy-to-understand label for your field, for example ‘First Name’ or ‘Email’.

Show Label

If enabled the label will be shown on your form. If you do not want the label to appear for a particular field, uncheck this box.

Hidden

If checked the field will be hidden on the form. It can be shown again using conditional logic or your own JavaScript.

Default Value

The default value setting is used to populate the field with a default value. Progress bars are usually set with a value from 0 to 1, so you should enter a numeric value from 0 to 1 in this field. If you leave it blank, it will be set to 0. For example 0.5 would set the progress bar to halfway.

WS Form variables can be entered into this field.

Source

The source pulldown has two options:

  • No source
  • Form Progress (Default)
  • Tab Progress
  • Upload Progress

When ‘Form Progress’ is selected, the progress bar will automatically show the progress of the form.

When ‘Tab Progress’ is selected, the progress will represent how far a user is through the tabs of a form.

When ‘Upload Progress’ is selected, the progress bar will show the progress of a form submission. This is useful if you have a file upload field on your form and you want to show the progress of that upload.

When ‘No source’ is set, you can manually set the progress bar value using conditional logic or another javascript source of your choice. You may wish to remove the default help text on the progress bar is you use this setting.

Help Text

The help text setting enables you to add smaller text under the field to assist the website visitor in completing that field.

As well as inserting plain text into this field, WS Form also provides extensive functionality for adding progress variables. The available progress variables are:

Progress
#progress The form progress represented as a number from 0 to 100.
#progress_percent The form progress represented as a percentage from 0% to 100%.
#progress_remaining The remaining form progress represented as a number from 100 to 0.
#progress_remaining_percent The remaining form progress represented as a percentage from 100% to 0%.

Other WS Form variables can be entered into this field.

Accessibility

ARIA Label

Accessible Rich Internet Applications (ARIA) defines ways to make web content and web applications more accessible to people with disabilities.

This setting enables you to define what text is made available to ARIA applications. This would, for example, provide a screen reader with specific text to read to someone with a disability.

The value of this setting defaults to your field label. If you would like to change this, enter a new value.

WS Form variables can be entered into this field.

Advanced

The advanced tab contains additional form attribute settings that provide further control over how a field is rendered.

Styles

Use the ‘Styles’ settings to change the design of the progress bar.

Label Position

There are five positions you can choose from for your label:

  • Default
  • Top
  • Left
  • Right
  • Bottom

The default position will place the label set in the form settings advanced tab. For new forms this will be the ‘Top’ positioning.

Note that when using some frameworks some label positions may not be available.

Label Width

If your label position is set to left or right, you can specify how wide the label will be. You can consider the overall width of the label and the field to be 12 columns (or whatever value is set in Form Settings). By default, labels are rendered at 3 columns wide (1/4 width), which means the field itself is 9 columns wide (3/4 width). You can change the width of the label using this setting.

To change the default width of all labels in your form:

1. Click the form settings icon.
2. Click the ‘Advanced’ tab.
3. Scroll down to ‘Default Label Width’ and change the setting.
4. Click ‘Save’ at the bottom.

Vertical Alignment

The vertical alignment option allows you to choose how this field will be vertically aligned in relation to fields in the same row. The options are:

  • Top
  • Middle
  • Bottom

Classes

For developers WS Form allows you to add your own classes to fields.

Field Wrapper

The wrapper CSS class setting enables you to add a class (or classes) to a field wrapper. Field wrappers are sections of HTML added around a field to position them on the page. To add multiple classes, add a space between the class names.

Field

To add a class to the actual field element itself, enter a class (or classes) to this setting. To add multiple classes, add a space between the class names.

Restrictions

Minimum

This is the minimum value for the progress bar. This defaults to 0 if left blank.

Maximum

This is the maximum value for the progress bar. This defaults to 1 if left blank.

User Status

Choose from one of the options to filter which user status can see this field:

  • Any
  • Is Logged In
  • Is Logged Out
  • Has User Role or Capability

If you choose ‘Has User Role or Capability’, additional settings will appear that enable you to choose one or more roles or capabilities.

Custom Attributes

This setting is used to add custom attributes to the HTML of this field, such as data-my-attribute="1234". You can add as many custom attributes as you need.

To add a custom attributes key value pair:

  1. Click the ‘Add’  icon to add a custom attribute row.
  2. Enter the key in the left column.
  3. Enter the value in the right column.
  4. Click ‘Save’ to save the custom attributes.

Breakpoints

The breakpoint settings define the width of a field and also what the offset (how many columns from the left-hand side of the form or the previous field) of a field is for each breakpoint. For more information about the breakpoint settings and capabilities of WS Form, click here.