Skip to content

Fix Forms component sidebar implementation#261

Merged
camposeddie merged 1 commit intodevelopfrom
EDPUB-1732-Fix-dashboard-misspelling
Jan 15, 2026
Merged

Fix Forms component sidebar implementation#261
camposeddie merged 1 commit intodevelopfrom
EDPUB-1732-Fix-dashboard-misspelling

Conversation

@ckd002
Copy link
Copy Markdown
Contributor

@ckd002 ckd002 commented Dec 22, 2025

Description

There was a misspelling in a path used to determine whether or not the sidebar was displayed. While testing the correction of this misspelling, I identified several undesired behaviors of this implementation. This PR updates the implementation to remove the undesired behaviors which also eliminates the misspelling.

Linked JIRA Task or Github Issue

JIRA Task: EDPUB-1732

Types of changes

What types of changes does your code introduce to Earthdata Pub (EDPub)?
Put an x in the boxes that apply

  • Bugfix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Documentation Update (if adding or updating the existing documentation resources)
  • Other (if none of the other choices apply)

Checklist

Put an x in the boxes that apply. You can also fill these out after creating the PR. If you're unsure about any of them, don't hesitate to ask. We're here to help! This is simply a reminder of what we are going to look for before merging your code.

  • I have read the Contributing Guide
  • I have updated the CHANGELOG
  • Lint and unit tests pass locally with my changes
  • I have added tests that prove my fix is effective or that my feature works
  • I have added the necessary documentation (if appropriate)
  • Any dependent changes have been merged and published in downstream modules

Validation Steps

This will help us get a jump start on validating your PR by describing the steps to replicate
and validate the expected behavior. (For an example of good validation instructions, check out Bryan's Bouncy Ball PR.)

  1. Make sure all merge request checks have passed (CI/CD).
  2. Pull related branches locally.
  3. Navigate to http://localhost:3000/forms
  4. Verify that no sidebar is displayed on the index page
  5. Click the Add Form button
  6. Verify that no sidebar is displayed on the add form page
  7. Navigate back to the forms page and click on a form name
  8. Verify that no sidebar is displayed on the edit page
  9. Navigate to the dashboard and create a request
  10. Move the request ahead to a form review step
  11. Verify that the sidebar is displayed
  12. On the sidebar, click Back to Forms
  13. Verify that the sidebar is no longer visible

Further comments

I initially just corrected the misspelling, but that made the /forms/add page shift to the left in an unpleasant manner. I found that this was due to the className for the content div being altered by the sidebar value. I couldn't find a reason for the className value to be altered by the sidebar and similar components (Sections, Workflows, Questions) have it hardcoded, so I removed the condition. I also realized that those components don't use conditionals for displaying the sidebar either so I attempted to remove that condition as well. This worked for the most part, but resulted in a quirk where if you navigated to a form review page and then clicked the Back to Forms link in the sidebar, the sidebar box would stay present on the forms, forms/add, forms/edit pages until you did a refresh. This led me to updating the conditional to check for the one case we do want the sidebar displayed.

@ckd002 ckd002 requested a review from a team as a code owner December 22, 2025 16:41
@ckd002 ckd002 changed the title Fix Forms component sidebar application Fix Forms component sidebar implementation Dec 22, 2025
@camposeddie camposeddie merged commit 9fb0a43 into develop Jan 15, 2026
1 check passed
@camposeddie camposeddie deleted the EDPUB-1732-Fix-dashboard-misspelling branch January 15, 2026 21:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants