Add 'draggable' attribute to component wrapper helper #4544
+136
−63
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
- some option were missing from the docs and the snippet of info shown on the component guide - restructure the tests, some tests were incorrectly nested - add a few extra tests to cover corner cases and expand initial test to include new attributes - make order of tests more consistent (invalid value, valid value, override value)
AshGDS
approved these changes
Jan 14, 2025
| it "can add aria attributes to already passed aria attributes" do | ||
| helper = GovukPublishingComponents::Presenters::ComponentWrapperHelper.new(aria: { label: "original-label", describedby: "other" }) | ||
| helper.add_aria_attribute({ label: "extra-label", controls: "something" }) | ||
| expect(helper.all_attributes[:aria]).to eql({ label: "original-label extra-label", describedby: "other", controls: "something" }) |
There was a problem hiding this comment.
Possibly a nitpick/complicating the wrapper, but should there be a set_aria_attribute function, or a boolean passed to add_aria_attribute that allows you to override the existing aria attributes instead of appending to the existing one? Currently this test appends more text to the label when overriding a label entirely seems like the more common use case. For example:
helper = GovukPublishingComponents::Presenters::ComponentWrapperHelper.new(aria: { label: "Expand menu", })
helper.add_aria_attribute({ label: "Collapse Menu" }) if the_menu_is_open_on_pageload
# In our current implementation, the label becomes "Expand menu Collapse Menu"There was a problem hiding this comment.
That's a good question. If it's all right I think I'll look at it in a separate PR, as there might be more options where having both an add and a set method might be useful.
|
Forgot to add a changelog entry, sorry 🤦 |
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
Adds the draggable attribute to the component wrapper helper.
Also includes a clean up/restructure of the tests, and adding some missing things to the documentation.
Why
Needed for the button component.
Visual Changes
None.
Trello card: https://trello.com/c/hUDC8lzz/418-add-component-wrapper-helper-to-button-component