Skip to content

Forms: Add step names and dots style to progress indicator #44472

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 6 commits into
base: trunk
Choose a base branch
from

Conversation

lezama
Copy link
Contributor

@lezama lezama commented Jul 25, 2025

Summary

Enhances the form progress indicator block with new display options and improved functionality:

  • Block Styles: Adds "Line" (default) and "Dots" style variations
  • Step Names Toggle: Adds setting to show/hide custom step names for both styles
  • Server-side Rendering: Implements PHP rendering using block context and Tag Processor
  • Block Context Integration: Uses WordPress block context system to share step data between form and progress indicator blocks
  • Fallback Support: Gracefully falls back to parsing post content when context data is unavailable

Features

Line Style (Default)

  • Shows traditional progress bar with optional step names below
  • Step names appear as labels positioned along the progress line

Dots Style

  • Shows circular dots representing each step
  • Active steps are highlighted with the current color
  • Step names appear below each dot when enabled

Settings Panel

  • Toggle to show/hide step names for both styles
  • Works with custom step labels set in form step blocks

Technical Implementation

  • Uses providesContext/usesContext for proper data sharing between blocks
  • Server-side rendering ensures SEO-friendly output and better performance
  • CSS-based styling with proper theme color integration
  • JavaScript handles active state updates during step navigation

Test plan

  • Create a multi-step form with custom step labels
  • Add progress indicator block
  • Test line style with step names on/off
  • Test dots style with step names on/off
  • Verify step names show custom labels, not generic ones
  • Test on frontend with step navigation
  • Verify active states update correctly

- Add block styles for line (default) and dots variations
- Add toggle setting to show/hide step names for both styles
- Implement block context system to share step data between form and progress indicator
- Add server-side rendering for steps using PHP Tag Processor
- Support custom step labels from form-step blocks
- Fallback to parsing post content when context data unavailable
Copy link
Contributor

github-actions bot commented Jul 25, 2025

Are you an Automattician? Please test your changes on all WordPress.com environments to help mitigate accidental explosions.

  • To test on WoA, go to the Plugins menu on a WoA dev site. Click on the "Upload" button and follow the upgrade flow to be able to upload, install, and activate the Jetpack Beta plugin. Once the plugin is active, go to Jetpack > Jetpack Beta, select your plugin (Jetpack), and enable the add/form-progress-indicator-improvements branch.
  • To test on Simple, run the following command on your sandbox:
bin/jetpack-downloader test jetpack add/form-progress-indicator-improvements

Interested in more tips and information?

  • In your local development environment, use the jetpack rsync command to sync your changes to a WoA dev blog.
  • Read more about our development workflow here: PCYsg-eg0-p2
  • Figure out when your changes will be shipped to customers here: PCYsg-eg5-p2

Copy link
Contributor

Thank you for your PR!

When contributing to Jetpack, we have a few suggestions that can help us test and review your patch:

  • ✅ Include a description of your PR changes.
  • 🔴 Add a "[Status]" label (In Progress, Needs Review, ...).
  • 🔴 Add a "[Type]" label (Bug, Enhancement, Janitorial, Task).
  • 🔴 Add testing instructions.
  • 🔴 Specify whether this PR includes any changes to data or privacy.
  • ✅ Add changelog entries to affected projects

This comment will be updated as you work on your PR and make changes. If you think that some of those checks are not needed for your PR, please explain why you think so. Thanks for cooperation 🤖


🔴 Action required: Please include detailed testing steps, explaining how to test your change, like so:

## Testing instructions:

* Go to '..'
*

🔴 Action required: We would recommend that you add a section to the PR description to specify whether this PR includes any changes to data or privacy, like so:

## Does this pull request change what data or activity we track or use?

My PR adds *x* and *y*.

Follow this PR Review Process:

  1. Ensure all required checks appearing at the bottom of this PR are passing.
  2. Make sure to test your changes on all platforms that it applies to. You're responsible for the quality of the code you ship.
  3. You can use GitHub's Reviewers functionality to request a review.
  4. When it's reviewed and merged, you will be pinged in Slack to deploy the changes to WordPress.com simple once the build is done.

If you have questions about anything, reach out in #jetpack-developers for guidance!

@github-actions github-actions bot added the [Status] Needs Author Reply We need more details from you. This label will be auto-added until the PR meets all requirements. label Jul 25, 2025
Copy link

jp-launch-control bot commented Jul 25, 2025

Code Coverage Summary

Coverage changed in 6 files. Only the first 5 are listed here.

File Coverage Δ% Δ Uncovered
projects/packages/forms/src/contact-form/class-contact-form-plugin.php 435/1232 (35.31%) -1.65% 55 💔
projects/packages/forms/src/blocks/form-progress-indicator/edit.js 0/15 (0.00%) 0.00% 6 💔
projects/packages/forms/src/blocks/contact-form/edit.js 0/216 (0.00%) 0.00% 3 ❤️‍🩹
projects/packages/forms/src/modules/form-progress-indicator/view.js 0/8 (0.00%) 0.00% 2 ❤️‍🩹
projects/packages/forms/src/blocks/form-progress-indicator/save.js 0/4 (0.00%) 0.00% 1 ❤️‍🩹

Full summary · PHP report · JS report

If appropriate, add one of these labels to override the failing coverage check: Covered by non-unit tests Use to ignore the Code coverage requirement check when E2Es or other non-unit tests cover the code Coverage tests to be added later Use to ignore the Code coverage requirement check when tests will be added in a follow-up PR I don't care about code coverage for this PR Use this label to ignore the check for insufficient code coveage.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
[Block] Contact Form Form block (also see Contact Form label) [Feature] Contact Form [Package] Forms [Status] Needs Author Reply We need more details from you. This label will be auto-added until the PR meets all requirements.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant