USWDS-Site: Add changelog for in-page navigation [#6205] #3000
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Todo: Update guidance to include this new data attribute |
amyleadem
suggested changes
Jan 3, 2025
There was a problem hiding this comment.
Thanks for this, @mlloydbixal! I added a comment below with some suggestions for copy updates.
Can you also add documentation for this new setting on the settings page and in the settings table on the in-page navigation page? Whoops, I mean can you add this prop to the "In-page navigation initialization properties" table?
Let me know if you have any questions.
Comment on lines
6
to
10
| summary: Hide in-page navigation when there are fewer than 2 headings. | ||
| summaryAdditional: The `data-minimum-heading-count` setting determines when the in-page navigation should be displayed or hidden if the minimum number of headings is not reached. Previously, in-page navigation was shown even when there were no headings, resulting in an empty component. This setting can be customized. | ||
| affectsGuidance: true | ||
| affectsJavascript: true | ||
| affectsMarkup: true |
There was a problem hiding this comment.
suggestion: Update the focus of the summary to highlight that this is a customizable setting. I also made some suggestions to change the "affects" tags here. Here is a possible rewrite:
Suggested change
| summary: Hide in-page navigation when there are fewer than 2 headings. | |
| summaryAdditional: The `data-minimum-heading-count` setting determines when the in-page navigation should be displayed or hidden if the minimum number of headings is not reached. Previously, in-page navigation was shown even when there were no headings, resulting in an empty component. This setting can be customized. | |
| affectsGuidance: true | |
| affectsJavascript: true | |
| affectsMarkup: true | |
| summary: Added the `data-minimum-heading-count` setting, which hides the component when the content region does not contain the minimum number of headings. | |
| summaryAdditional: By default, this setting hides the in-page navigation component when there are fewer than two headings in the content region. Teams should customize the value of this setting based on their content needs. | |
| affectsJavascript: true | |
| affectsSettings: true |
22 tasks
amyleadem
reviewed
Jan 22, 2025
amyleadem
reviewed
Jan 22, 2025
amyleadem
reviewed
Jan 22, 2025
amyleadem
reviewed
Jan 22, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
Add a changelog for PR uswds/uswds#6205
Important
We need to update the changelog dates before merge.
Preview link
In-page navigation changelog