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

#3463: Add breadcrumb to analytics page - [LITTERBOX] #3478

Merged
merged 6 commits into from
Feb 11, 2025

Conversation

zandercymatics
Copy link
Contributor

@zandercymatics zandercymatics commented Feb 6, 2025

Ticket

Resolves #3463

Changes

  • Updates the breadcrumb on the django admin analytics page to more accurately reflect its location

Context for reviewers

During accessibility testing, it was noted that the side nav bar would "disappear" at smaller resolutions. It was eventually determined that navigation still was accessible, but it was hidden behind confusing UI because our breadcrumb was not properly configured.

This PR tightens that up. Our next eventual step might be to properly integrate the analytics page into Django admin (as it currently is not), but for the scope and overarching goal of this ticket that is not done here.

Setup

To test this, go to django admin and click "Dashboard" under the analytics app. Note the breadcrumb.
Try going into mobile view, you should be able to navigate back to home using the breadcrumb and the .gov button.

Code Review Verification Steps

As the original developer, I have

Satisfied acceptance criteria and met development standards

  • Met the acceptance criteria, or will meet them in a subsequent PR
  • Created/modified automated tests
  • Update documentation in READMEs and/or onboarding guide

Ensured code standards are met (Original Developer)

  • If any updated dependencies on Pipfile, also update dependencies in requirements.txt.
  • Interactions with external systems are wrapped in try/except
  • Error handling exists for unusual or missing values

Validated user-facing changes (if applicable)

  • Tag @dotgov-designers in this PR's Reviewers for design review. If code is not user-facing, delete design reviewer checklist
  • Verify new pages have been added to .pa11yci file so that they will be tested with our automated accessibility testing
  • Checked keyboard navigability
  • Tested general usability, landmarks, page header structure, and links with a screen reader (such as Voiceover or ANDI)

As a code reviewer, I have

Reviewed, tested, and left feedback about the changes

  • Pulled this branch locally and tested it
  • Verified code meets all checks above. Address any checks that are not satisfied
  • Reviewed this code and left comments. Indicate if comments must be addressed before code is merged
  • Checked that all code is adequately covered by tests
  • Verify migrations are valid and do not conflict with existing migrations

Validated user-facing changes as a developer

Note: Multiple code reviewers can share the checklists above, a second reviewer should not make a duplicate checklist. All checks should be checked before approving, even those labeled N/A.

  • New pages have been added to .pa11yci file so that they will be tested with our automated accessibility testing
  • Checked keyboard navigability
  • Meets all designs and user flows provided by design/product
  • Tested general usability, landmarks, page header structure, and links with a screen reader (such as Voiceover or ANDI)
  • (Rarely needed) Tested as both an analyst and applicant user

As a designer reviewer, I have

Verified that the changes match the design intention

  • Checked that the design translated visually
  • Checked behavior. Comment any found issues or broken flows.
  • Checked different states (empty, one, some, error)
  • Checked for landmarks, page heading structure, and links

Validated user-facing changes as a designer

  • Checked keyboard navigability
  • Tested general usability, landmarks, page header structure, and links with a screen reader (such as Voiceover or ANDI)
  • Tested with multiple browsers (check off which ones were used)
    • Chrome
    • Microsoft Edge
    • FireFox
    • Safari
  • (Rarely needed) Tested as both an analyst and applicant user

References

Screenshots

@zandercymatics zandercymatics changed the title [draft] #3263: Add breadcrumb to analytics page [draft] #3463: Add breadcrumb to analytics page Feb 6, 2025
@zandercymatics zandercymatics changed the title [draft] #3463: Add breadcrumb to analytics page [draft] #3463: Add breadcrumb to analytics page - [LITTERBOX] Feb 7, 2025
@zandercymatics zandercymatics changed the title [draft] #3463: Add breadcrumb to analytics page - [LITTERBOX] #3463: Add breadcrumb to analytics page - [LITTERBOX] Feb 7, 2025
Copy link

🥳 Successfully deployed to developer sandbox za.

@therealslimhsiehdy therealslimhsiehdy self-assigned this Feb 10, 2025
Copy link
Contributor

@therealslimhsiehdy therealslimhsiehdy left a comment

Choose a reason for hiding this comment

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

LGTM! Tested via ANDI and in mobile view as well.

Before:
Screenshot 2025-02-10 at 8 55 07 AM

After:
Screenshot 2025-02-10 at 8 55 01 AM

{% endcomment %}
<div class="breadcrumbs">
<a href="{% url "admin:index" %}">{% trans "Home" %}</a>
&rsaquo;
Copy link
Contributor

@therealslimhsiehdy therealslimhsiehdy Feb 10, 2025

Choose a reason for hiding this comment

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

Question: What is the reasoning behind using the text of &rsaquo; (which translates to "›") versus ">"?

Copy link
Contributor Author

@zandercymatics zandercymatics Feb 10, 2025

Choose a reason for hiding this comment

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

Its what the original django template uses! If I just used ">" it wouldn't be consistent with the other pages.
As for the why, I am not sure why the django team is using that specifically (but maybe its for visual distinction?)

Copy link
Contributor

@therealslimhsiehdy therealslimhsiehdy left a comment

Choose a reason for hiding this comment

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

See previous comment for screenshots -- I just forgot to hit approve!

Copy link

🥳 Successfully deployed to developer sandbox za.

@zandercymatics zandercymatics merged commit 3fc09a8 into main Feb 11, 2025
10 checks passed
@zandercymatics zandercymatics deleted the za/3463-fix-analytics-breadcrumb branch February 11, 2025 16:44
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.

Mitigation Statement and pushback on 200% Zoom Navigation Issue
3 participants