Skip to content
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

VAGOV-TEAM-97904: Adds Form Builder Page Template #20052

Merged
merged 4 commits into from
Dec 10, 2024

Conversation

ryguyk
Copy link
Contributor

@ryguyk ryguyk commented Dec 9, 2024

Description

  • Adds a pagel-level Twig template for Form Builder pages.
  • Applies this template to all Form Builder routes (all routes that begin with va_gov_form_builder..

Closes department-of-veterans-affairs/va.gov-team#97904

Testing done

  • Unit tests added
    • Ensure theme hook sets the appropriate template and path properties.
    • Ensure theme-suggestions hook returns the appropriate theme suggestion.
    • Ensure template includes expected elements (page wrapper, navbar).
    • Ensure template does not include elements that should be removed relative to default theme (breadcrumbs).
  • Manual testing done locally to confirm all expected routes have the template applied.

Screenshots

Here is a local screenshot. Other environments might lack the debugging information, but the other two highlighted pieces are the critical parts.
image

QA steps

  1. Navigate to /form-builder/intro
    • Ensure rendered markup includes the elements noted in the screenshot.
  2. Navigate to /form-builder/start-conversion
    • Ensure rendered markup includes the elements noted in the screenshot.
  3. Continue with additional routes as desired.

Definition of Done

  • Documentation has been updated, if applicable.
  • Tests have been added if necessary.
  • Automated tests have passed.
  • Code Quality Tests have passed.
  • Acceptance Criteria in related issue are met.
  • Manual Code Review Approved.
  • If there are field changes, front end output has been thoroughly checked.

Select Team for PR review

  • CMS Team
  • Public websites
  • Facilities
  • User support
  • Accelerated Publishing
  • Form Engine

Is this PR blocked by another PR?

  • DO NOT MERGE

Does this PR need review from a Product Owner

  • Needs PO review

CMS user-facing announcement

Is an announcement needed to let editors know of this change?

  • Yes, and it's written in issue ____ and queued for publication.
    • Merge and ping the UX writer so they are ready to publish after deployment
  • Yes, but it hasn't yet been written
    • Don't merge yet -- ping the UX writer to write and queue content
  • No announcement is needed for this code change.
    • Merge & carry on unburdened by announcements

@va-cms-bot va-cms-bot temporarily deployed to Tugboat December 9, 2024 15:48 Destroyed
Copy link

github-actions bot commented Dec 9, 2024

Checking composer.lock changes...

Copy link

github-actions bot commented Dec 9, 2024

Checking composer.lock changes...

- Adds Twig template for Form Builder pages.
- Applies template to all Form Builder routes.
@ryguyk ryguyk force-pushed the VAGOV-TEAM-97904-form-builder-template branch from 0982fb9 to d9c222d Compare December 9, 2024 16:35
@va-cms-bot va-cms-bot temporarily deployed to Tugboat December 9, 2024 16:35 Destroyed
Copy link

github-actions bot commented Dec 9, 2024

Checking composer.lock changes...

@ryguyk ryguyk marked this pull request as ready for review December 9, 2024 16:47
@ryguyk ryguyk requested a review from a team as a code owner December 9, 2024 16:47
@ryguyk ryguyk requested a review from derekhouck December 9, 2024 17:14
@va-cms-bot va-cms-bot temporarily deployed to Tugboat December 10, 2024 08:47 Destroyed
@ryguyk ryguyk mentioned this pull request Dec 10, 2024
22 tasks
Copy link
Contributor

@derekhouck derekhouck left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM. I tested the routes locally and the template appears to be activating on the correct pages.

@va-cms-bot va-cms-bot temporarily deployed to Tugboat December 10, 2024 18:37 Destroyed
Copy link

Checking composer.lock changes...

@va-cms-bot va-cms-bot temporarily deployed to Tugboat December 10, 2024 21:31 Destroyed
Copy link

Checking composer.lock changes...

@va-cms-bot
Copy link
Collaborator

Cypress Accessibility Violations

/test-data-nemo

ID: button-name
Impact: critical
Tags: cat.name-role-value, wcag2a, wcag412, section508, section508.22.a, ACT, TTv5, TT6.a
Description: Ensures buttons have discernible text
Help: Buttons must have discernible text
Nodes:

  • HTML: <button class="proofing-element-help" role="tooltip" data-proofing-help-title="About 'Page introduction' field" data-proofing-help="Add an introduction that helps visitors understand if information on the page is relevant to them."> <span aria-hidden="true">i</span> </button>
    Impact: critical
    Target: .field--name-field-intro-text-limited-html > .field__label > .proofing-element-help[role="tooltip"]
    Summary: Fix any of the following:
    Element does not have inner text that is visible to screen readers
    aria-label attribute does not exist or is empty
    aria-labelledby attribute does not exist, references elements that do not exist or references elements that are empty
    Element has no title attribute
    Element's default semantics were not overridden with role="none" or role="presentation"

  • HTML: <button class="proofing-element-help" role="tooltip" data-proofing-help-title="About 'Generate a table of contents from major headings' field" data-proofing-help="By checking this box, all h2's below this point on the page will be linked with with anchor links. This helps users navigate content on very long pages. Do not check this box unless there is at least 2 h2's on the page.">
    Impact: critical
    Target: .field--name-field-table-of-contents-boolean > .field__label > .proofing-element-help[role="tooltip"]
    Summary: Fix any of the following:
    Element does not have inner text that is visible to screen readers
    aria-label attribute does not exist or is empty
    aria-labelledby attribute does not exist, references elements that do not exist or references elements that are empty
    Element has no title attribute
    Element's default semantics were not overridden with role="none" or role="presentation"

  • HTML: <button class="proofing-element-help" role="tooltip" data-proofing-help-title="About 'Main content' field" data-proofing-help="The main body of the page, which appears below the featured content."> <span aria-hidden="true">i</span> </button>
    Impact: critical
    Target: button[data-proofing-help-title="About 'Main content' field"]
    Summary: Fix any of the following:
    Element does not have inner text that is visible to screen readers
    aria-label attribute does not exist or is empty
    aria-labelledby attribute does not exist, references elements that do not exist or references elements that are empty
    Element has no title attribute
    Element's default semantics were not overridden with role="none" or role="presentation"

@ryguyk ryguyk merged commit ed635cc into main Dec 10, 2024
18 checks passed
@ryguyk ryguyk deleted the VAGOV-TEAM-97904-form-builder-template branch December 10, 2024 23:31
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.

Create a template for Form Builder pages
3 participants