fix(root): removed attribute sections if they aren't included #1237
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
added check if value exists before rendering section in the attribute table
|
View your branch deployment here: https://mi6.github.io/ic-design-system-githubpages/branches/remove-missing-attributes |
GCHQ-Developer-530
previously approved these changes
Dec 4, 2024
added role="list" to wrapper of footer-links to prevent a11y failures. Also added example to code snippets to show how to do it
GCHQ-Developer-530
approved these changes
Dec 4, 2024
GCHQ-Developer-112
approved these changes
Dec 4, 2024
2 tasks
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 of the changes
When our JSON docs are generated in the ic-ui-kit, any properties that have an object type cannot be set as attributes in regular HTML, thus are not given an attribute name in the auto-generated docs. To prevent rendering empty sections on the guidance site when this is the case, have added a check to the AttributeTable to not render a header/value when the value is not present (in this case when props do not have a corresponding attribute name)
Also added aria-role to wrapper of the ic-footer-links with the gov logos, to prevent automated a11y failures. Added this to code examples as well to show others how to do it.
Related issue
#1038 #1174 #1178
Checklist