Use component wrapper in hint component #4214
Merged
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
kevindew
force-pushed
the
hint-extra-options
branch
from
ecf4cb4
to
fb01eee
Compare
andysellick
approved these changes
Sep 10, 2024
| @@ -25,3 +26,9 @@ examples: | |||
| data: | |||
| text: "العربيَّة" | |||
| right_to_left: true | |||
| with_js_class: | |||
There was a problem hiding this comment.
You're very welcome to add an explicit documentation of this feature, but just to let you know that the options for the component wrapper are automatically added to the top of this guide page when uses_component_wrapper_helper is included.
There was a problem hiding this comment.
That's a good shout. I'll remove it. I added a test for it already so there's something to stop a regression.
This adds the component wrapper to the hint component in order to provide additional options to a hint. The primary motivation of this was that we want to dynamically change the value of a hint in GOV.UK Chat and thus want to set a .js-class to act as a selector [1] (private repo) and instead are using a custom id to work around it. Looking at other components it seemed that using the component wrapper was a more conventional approach than just utilising the shared helper to add only classes. [1]: alphagov/govuk-chat#660 (comment)
kevindew
force-pushed
the
hint-extra-options
branch
from
fb01eee
to
cf26c7b
Compare
Merged
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.
What
This adds the component wrapper to the hint component in order to provide additional options to a hint.
Why
The primary motivation of this was that we want to dynamically change the value of a hint in GOV.UK Chat and thus want to set a .js-class to act as a selector 1 (private repo) and instead are using a custom id to work around it.
Looking at other components it seemed that using the component wrapper was a more conventional approach than just utilising the shared helper to add only classes.
Visual Changes
None