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

Update f2 with footnotes example #673

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Conversation

rezrah
Copy link
Collaborator

@rezrah rezrah commented Jul 29, 2024

Summary

Adds footnotes example to F2 template as an interim workaround for not having a dedicated component

What should reviewers focus on?

  • Verify correctness of design, and the assumptions made in this PR
    • Text size: 100
    • Color: muted
    • Works in either single paragraphs (using <br />) or multiple paragraphs (relying on Stack spacing)
    • Fills entire width on narrow viewports
    • Offset by 2 columns on regular+ viewports. Reading across 12 columns is quite difficult IMO.
    • Top spacing: 64px on narrow, 128 on regular+

Steps to test:

  1. Scroll to the bottom of this story

Contributor checklist:

  • All new and existing CI checks pass
  • Tests prove that the feature works and covers both happy and unhappy paths
  • Any drop in coverage, breaking changes or regressions have been documented above
  • New visual snapshots have been generated / updated for any UI changes
  • All developer debugging and non-functional logging has been removed
  • Related issues have been referenced in the PR description

Reviewer checklist:

  • Check that pull request and proposed changes adhere to our contribution guidelines and code of conduct
  • Check that tests prove the feature works and covers both happy and unhappy paths
  • Check that there aren't other open Pull Requests for the same update/change

Screenshots:

Screenshot 2024-07-29 at 14 53 15

Screenshot 2024-07-29 at 14 53 22

Screenshot 2024-07-29 at 14 35 33

Copy link

changeset-bot bot commented Jul 29, 2024

⚠️ No Changeset found

Latest commit: c68db26

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

Copy link
Contributor

🟢 No design token changes found

Copy link
Contributor

🟢 No visual differences found

Our visual comparison tests did not find any differences in the UI.

@nsolerieu
Copy link
Contributor

@rezrah I agree with most of your suggestions, here are some additional specs considering the pointers form a11y @natalie-iv gathered

  • Use numbers (not symbols)
  • Provide a back link (view original context label here)
  • 80px spacer outside spacer, 24px within the stack
  • Extract the number and align with text block
  • Small body copy at 14px - text color secondary
  • 9 col max (924px) width to fit line length
Screenshot 2024-07-29 at 2 20 31 PM

@waynewi
Copy link

waynewi commented Jul 29, 2024

@rezrah can we have this same direction added to the solutions templates so we can fold it into the work currently happening on the MPS side?

@rezrah
Copy link
Collaborator Author

rezrah commented Jul 30, 2024

Thanks everyone. Update on this PR in Slack...

@nsolerieu
Copy link
Contributor

Documentation notes:

Default use:

For a basic context agnostic use-case (legal disclaimer, sources, references), Footnotes should live before the footer

Accessibility recommendation:

To limit cognitive requirement, we recommended collocating footnotes closer to initial context by including them at teh bottom of the section in which the initial content is presented

When content allows:

The tooltip component is an in-context solution, ideal when very short content allows

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.

3 participants