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

feat!: Make terms bold instead of descriptions in Description List #1693

Merged
merged 11 commits into from
Oct 24, 2024

Conversation

VincentSmedinga
Copy link
Contributor

@VincentSmedinga VincentSmedinga commented Oct 21, 2024

Describe the pull request

Thank you for contributing to the project!
Please use this template to help us handle your PR smoothly.

What

Following a request from our community, We’ve revised our earlier decision to display the descriptions of a Description List with bold text. Instead, we want the terms to be bold.

Why

Regular text is easier to read, especially if it is long as in form summaries. Making terms bold matches the header in forms. All communities in NLDS use bold for the terms, not the descriptions.

How

  • Updated the relevant tokens and CSS.
  • Removed a list-wide font-weight token that wasn’t used. This makes the change breaking.
  • Improved the content of the examples, sourcing from our editorial guide.
  • Changed ‘details’ to ‘description’ in docs – because MDN does so for <dd> and it does not clash with <details>.

Checklist

Before submitting your pull request, please ensure you have done the following. Check each checkmark if you have done so or if it wasn't necessary:

  • Add or update unit tests
  • Add or update documentation
  • Add or update stories
  • Add or update exports in index.* files
  • Start the PR title with a Conventional Commit prefix, as explained here.

Additional notes

  • We should rename DescriptionList.Details to DescriptionList.Description and the details tokens and classes. Let’s do this in a separate PR.
  • An inline style in the ‘Multiple terms’ example hides a bug (a ticket exists for it).
  • Customizing the widths of the columns, another request from the same source, also has its own ticket.

@github-actions github-actions bot temporarily deployed to demo-DES-993-description-list-font-weights October 21, 2024 15:42 Destroyed
RubenSibon
RubenSibon previously approved these changes Oct 22, 2024
@github-actions github-actions bot temporarily deployed to demo-DES-993-description-list-font-weights October 23, 2024 18:29 Destroyed
@github-actions github-actions bot temporarily deployed to demo-DES-993-description-list-font-weights October 23, 2024 18:32 Destroyed
@alimpens alimpens merged commit cc8f40e into develop Oct 24, 2024
6 checks passed
@alimpens alimpens deleted the feature/DES-993-description-list-font-weights branch October 24, 2024 09:52
@github-actions github-actions bot mentioned this pull request Oct 25, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

3 participants