Refactor: don't depend on underscore.js #116
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
This uses the DOM API to crate the elements instead of using templates from underscorejs. The html structure is exactly the same.
agjohnson
approved these changes
Aug 9, 2022
There was a problem hiding this comment.
Looks good to me!
Another approach here would be to move the template into an HTML template. There might be a slight benefit to this approach as it could be translated alongside other Sphinx resources, and the search page would be localized to match the documentation locale. I would consider this for future changes to this extension, it doesn't need to compete with this implementation. I'll open an issue
|
|
||
| let separator = createDomNode("br", {class: "br-for-hits"}); |
There was a problem hiding this comment.
If more space is needed, wrapping in a <p> is preferable to styling spacing using <br>, which should almost always be avoided. The issue with <br> is that it is difficult to style around. Wrapping each block in <p> should get you similar vertical spacing however.
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.
This uses the DOM API to create the elements
instead of using templates from underscorejs.
The HTML structure is exactly the same.
Would be great to re-structure the HTML of the results in a major version release, a more simple structure and use CSS for spacing instead of br elements.
The only usage of jQuery that is left is for fade in/out animations.