GOVUK.Modules.start can accept DOM elements #2260
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
module-start-no-jquery
branch
from
c41e119 to
2d1efbf
Compare
JonathanHallam
approved these changes
Aug 16, 2021
This adjusts GOVUK.Modules.find to be able to handle the situation where the input is not a jQuery object and can instead be a DOM element. This has been done so that GOVUK.Modules.start need not only be called with jQuery wrapped elements. The reason for this is to support GOV.UK in its journey away from jQuery. Previously we needed to add jQuery back into code so that this function could be called [1], whereas this change allows a regular DOM element to be injected. In the longer term I expect that we could deprecate calling this function with a jQuery object and then remove it (or replace `start` with an `init` method to match modules). [1]: https://github.com/alphagov/finder-frontend/blob/67f01543cb9ce5d5331f423061630acc6619d3c0/app/assets/javascripts/live_search.js#L198
kevindew
force-pushed
the
module-start-no-jquery
branch
from
2d1efbf to
9734b48
Compare
kevindew
added a commit
to alphagov/finder-frontend
that referenced
this pull request
Aug 16, 2021
This change removes jQuery from this script, it is dependent on govuk_publishing_components having released alphagov/govuk_publishing_components#2260
chris-gds
pushed a commit
that referenced
this pull request
Aug 17, 2021
Merged
kevindew
added a commit
to alphagov/finder-frontend
that referenced
this pull request
Aug 18, 2021
This change removes jQuery from this script, it is dependent on govuk_publishing_components having released alphagov/govuk_publishing_components#2260
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.
Trello: https://trello.com/c/pATsfsuD/524-convert-finder-frontend-module-initialisers-in-livesearchjs-to-not-use-jquery
What
This adjusts
GOVUK.Modules.findto be able to handle the situation where the input is not a jQuery object and can instead be a DOM element. This has been done so that GOVUK.Modules.start need not only be called with jQuery wrapped elements.Why
The reason for this is to support GOV.UK in its journey away from jQuery. Previously we needed to add jQuery back into code so that this function could be called, whereas this change allows a regular DOM element to be injected.
It will allow us to change this code
from
GOVUK.modules.start($(this.$resultsWrapper))toGOVUK.modules.start(this.$resultsWrapper).In the longer term I expect that we could deprecate calling this function with a jQuery object and then remove it (or replace
startwith aninitmethod to match modules).Visual Changes
None