[2.x] Extract vendor file for the HydeSearch script#2031
Merged
emmadesilva merged 8 commits intorefactor-hydefront-styles-to-tailwindfrom Nov 16, 2024
Merged
Conversation
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## refactor-hydefront-styles-to-tailwind #2031 +/- ##
=========================================================================
Coverage 100.00% 100.00%
Complexity 1906 1906
=========================================================================
Files 195 195
Lines 5078 5078
=========================================================================
Hits 5078 5078 ☔ View full report in Codecov by Sentry. |
3a316af to
cf4d641
Compare
This was referenced Nov 16, 2024
Merged
This file contains hidden or 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
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.
Abstract
Extracts a file in the framework vendor resources for the bulk HydeSearch scripts introduced by #2029 as it feels wrong to have so much JavaScript inline, especially as we don't really want users to tinker with it unless they know what they're doing.
Note that I decided against documenting the overloading feature as I think it's such a slim use case, and anyone determined to do it will easily be able to find it in the source.
Motivation
Benefits of this approach:
Potential concerns:
However, given Hyde's focus on simplicity and working out of the box, I think the benefits outweigh the drawbacks. We could even add a simple minified version of the file to use in production.
Customization
The search functionality can be customized by creating a
resources/js/HydeSearch.jsfile in your project. If this file exists, Hyde will use your implementation instead of the default one.It follows the same pattern Hyde uses for other assets and provides a clear override mechanism. Here's why it's intuitive: