Data attributes for option select button #3750
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
andysellick
added a commit
to alphagov/finder-frontend
that referenced
this pull request
Dec 6, 2023
- allow it to accept data attributes to be applied to the expand/collapse button - will allow us to add GA4 tracking via a Rails/component approach and remove some JS - likely to be a breaking change as will depend on some other stuff in a subsequent commit - brings the component more in line with the option select component changes coming here: alphagov/govuk_publishing_components#3750
andysellick
force-pushed
the
option-select-button
branch
from
1533a8a
to
a223f99
Compare
andysellick
force-pushed
the
option-select-button
branch
from
a223f99
to
8b8bb51
Compare
andysellick
changed the title
AshGDS
approved these changes
Dec 6, 2023
There was a problem hiding this comment.
Looks good 👍
Do you think it's worth having a try/catch safeguard on the JavaScript in case the value doesn't come through as a JSON? E.g. passing button_data_attributes: "hello" crashes the JS. This is probably an incredibly rare scenario so don't worry about it if you think it's over engineering the code.
|
@AshGDS good shout, we do that everywhere else so we should do it here. Have pushed another commit if you've got time to take a look, will squash before merging. |
AshGDS
previously approved these changes
Dec 6, 2023
AshGDS
dismissed
their stale review
Whoops, didn't mean to approve if further changes are coming
andysellick
force-pushed
the
option-select-button
branch
from
ec99028
to
4d008d9
Compare
|
@AshGDS I'm not intending adding further changes to this PR, so you can approve if you're happy. I'll roll this out as a breaking release and get it into alphagov/finder-frontend#3224 |
AshGDS
approved these changes
Dec 6, 2023
andysellick
force-pushed
the
option-select-button
branch
2 times, most recently
from
3d04ecd
to
0ffde2c
Compare
- modify the option select component to allow it to accept data attributes to be added to the expand/collapse button - the attributes are rendered on the parent element, then read in by JavaScript to be included in the JavaScript generated button, which replaces the title element of the component - to be used for GA4 tracking purposes in finder-frontend, in place of an existing solution - will be a breaking change, as removes the event listener that was previously being used for this - credit to @floehopper
andysellick
force-pushed
the
option-select-button
branch
from
0ffde2c
to
114d9ed
Compare
andysellick
changed the title
Closed
Merged
andysellick
added a commit
to alphagov/finder-frontend
that referenced
this pull request
Dec 12, 2023
- allow it to accept data attributes to be applied to the expand/collapse button - will allow us to add GA4 tracking via a Rails/component approach and remove some JS - likely to be a breaking change as will depend on some other stuff in a subsequent commit - brings the component more in line with the option select component changes coming here: alphagov/govuk_publishing_components#3750
andysellick
added a commit
to alphagov/finder-frontend
that referenced
this pull request
Dec 12, 2023
- allow it to accept data attributes to be applied to the expand/collapse button - will allow us to add GA4 tracking via a Rails/component approach and remove some JS - likely to be a breaking change as will depend on some other stuff in a subsequent commit - brings the component more in line with the option select component changes coming here: alphagov/govuk_publishing_components#3750
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
Why
We're currently using a system of event and event listeners between
finder-frontendand this component in order to track this button's expand/collapse action. This approach allows us to remove some JavaScript and move most of the heavy lifting to the backend, which should reduce load on the frontend.This PR in
finder-frontendis dependent on this change, and will need to be merged together: alphagov/finder-frontend#3224Visual Changes
None.
Trello card: https://trello.com/c/OdYXlYqQ/673-finder-frontend-code-optimisations