Skip to content

backdrop-contrib/multistep

Repository files navigation

MultiStep

Summary

Multistep adds multiple-step functionality to node type editing forms. It does so by assigning a step number to each field or field group within the node type and hiding all the fields or groups that do not belong to the current step. The user can then use different submitting buttons that will redirect to the previous, next, or current step.

The module also provides a block for each node type with a menu of the different groups within that form and a progress bar. This provides an easy way to jump to different steps throughout the form without having to go one by one as well as keeping track of the progress of the form.

Requirements

This module requires Fields, which is part of Backdrop core. It also benefits strongly from Field Group, which can be found at https://backdropcms.org/project/field_group

Installation

To Use

Whenever you add or edit a field group you can select the "Multistep: Form step" type. Any fields nested within that group will only be shown when the user is on that step.

If you are configuring multistep for a content type that already had data previously, you should go to Configuration >> Multistep and reset the table for that node type. This will create step data for all nodes that were previously created.

If you have a Taxonomy vocabulary set for the content type, you will see an option to set which step it should belong to in the content type editing form after you save the number of steps.

Configuration

To configure the multistep menu and the progress bar, go to Administer >> Site building >> Blocks and configure the corresponding block that will appear on the list. You can select whether to enable or disable the menu and the progress bar.

To remove/show the Preview button on the node editing form, go to the content type editing form in Administer >> Content management >> Content types and check/uncheck the box that says "Hide Preview button".

To change the text that appears on the different buttons of the form (Previous, Next, Save, Done), go to the admin settings page in Administer >> Site configuration >> Multistep and modify the values shown in the Navigation button labels section.

Users with "toggle multistep" permission can select whether to view the entire form in a single page or the multistep form split over multiple pages. This is useful for vieweing a whole form at a glance before starting to enter the data.

You can also set whether the default display of the form is the multistep form or the entire form. Only users with "toggle multistep" permissions will be able to switch displays.

Development

For hooks provided by Multistep, read multistep.api.php

Issues

Bugs and feature requests should be reported in the Issue Queue.

Current Maintainers

Credits

License

This project is GPL v2 software. See the LICENSE.txt file in this directory for complete text.

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors