Fix glossary header bug #7371
Merged
Fix glossary header bug #7371
Conversation
This file contains 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
- [x] tested when glossary is not enabled - [x] tested when glossary is enabled with summary box - [x] updated glossary.html to set header class for tagetting to hide in summary-box.js - [x] set conditional to hide/display glossary.html partial based on glossary field set in parent _index.md
nick-mon1
added
bug
nick-mon1
commented
Mar 1, 2024
Comment on lines
+22
to
+24
| {{- if .Parent.Params.glossary -}} | ||
| {{- partial "core/glossary.html" . -}} | ||
| {{- end -}} |
There was a problem hiding this comment.
Check if .Parent page has glossary field set. This refers to the root _index.md in the guide directory.
nick-mon1
commented
Mar 1, 2024
| @@ -13,7 +13,7 @@ | |||
| </svg> | |||
| </button> | |||
|
|
|||
| <h2>Glossary</h2> | |||
| <h2 class="dg-glossary__header">Glossary</h2> | |||
There was a problem hiding this comment.
Added class as a hook for the javascript.
nick-mon1
commented
Mar 1, 2024
| @@ -10,7 +10,7 @@ | |||
|
|
|||
| const guideSummaryList = guideSummary.querySelector(".usa-list"); | |||
| const pageHeaders = document.querySelectorAll( | |||
| "h2:not(.usa-summary-box__heading, .dg-guide__content-header-title)" | |||
| "h2:not(.usa-summary-box__heading, .dg-guide__content-header-title, .dg-glossary__header)" | |||
There was a problem hiding this comment.
This query acts as "blacklist" of headers to not in the summary box component depending on the page it is called from.
This comment was marked as resolved.
This comment was marked as resolved.
mejiaj
suggested changes
Mar 7, 2024
mejiaj
suggested changes
Mar 14, 2024
clmedders
approved these changes
Mar 18, 2024
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
Guide pages that display a
summary-boxcomponent also display the Glossaryh2when it should not be visible.glossary.htmlis unnecessarily rendered on guide pages that don't use a glossary.See guides/dap/common-questions-about-dap
Preview
Link to Preview
Solution
glossary.htmlwhen.Parent.Params.glossaryis true.summary-boxcomponent is used on a page with aglossarycomponent enabled, then don't display the Glossaryh2.h2insummary-box.jsHow To Test
summary boxwhen glossary is not enabled.summary boxwhen glossary is enabled.summary_box: trueoncontent/guides/hcd/discovery-concepts/present.mdon your local machinesummary boxwhen glossary is enabled.summary_box: trueoncontent/guides/hcd/introduction/_index.mdon your local machineWhat To Test
glossary.htmlis not rendered whenglossaryfield is not setdg-glossary__containeris not present in markupsummary-boxcomponent does not display Glossaryh2at all (even when set).Dev Checklist