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

Component wrapper documentation fixes #4499

Merged
merged 2 commits into from
Dec 13, 2024
Merged

Conversation

andysellick
Copy link
Contributor

What

Update the component wrapper documentation to include recently added options e.g. tabindex.

Fix a bug with the component guide where the component wrapper options weren't being shown for components that only have one variation (e.g. contextual guidance).

Why

Keeping documentation up to date.

Visual Changes

Changes on the component guide page to the contextual guidance component.

Before After
Screenshot 2024-12-12 at 13 05 57 Screenshot 2024-12-12 at 13 06 02
Screenshot 2024-12-12 at 13 06 30 Screenshot 2024-12-12 at 13 06 19

Trello card: https://trello.com/c/ZHmeJbMd/380-fix-missing-component-wrapper-information-on-components-without-variations

- was missing documentation for a few of the options
- some components use the component wrapper helper but don't have more than one, default example of their appearance in the component guide. A bug meant that in this case the detail of the component wrapper helper wasn't automatically being shown at the top of the list of other examples (because there were no other examples)
- correcting and updating the jump link list at the top to also include this as an item
@andysellick andysellick requested a review from AshGDS December 12, 2024 13:08
@govuk-ci govuk-ci temporarily deployed to components-gem-pr-4499 December 12, 2024 13:08 Inactive
Copy link
Contributor

@AshGDS AshGDS left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM 👍

@andysellick andysellick merged commit d987c23 into main Dec 13, 2024
12 checks passed
@andysellick andysellick deleted the component-wrapper-doc branch December 13, 2024 10:35
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