Skip to content

fix: enable local page Search and default to PyData search on 'Enter' #584

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 4 commits into from
Nov 13, 2024
Merged

fix: enable local page Search and default to PyData search on 'Enter' #584

merged 4 commits into from
Nov 13, 2024

Conversation

@Revathyvenugopal162
Copy link
Contributor

@Revathyvenugopal162 Revathyvenugopal162 commented Nov 11, 2024 •
edited
Loading

fixes #581

Enhancements to Search Functionality:

  1. "Enter" Key Navigation to First Result:

    • Pressing "Enter" now directly navigates to the first search result.
    • If no search results are found, pressing "Enter" redirects the user to a PyData search interface.

  2. Local HTML File Search for Development:

    • In local environments, the search function now works seamlessly with local HTML files, allowing developers to use PyData's search capabilities locally.

@Revathyvenugopal162 Revathyvenugopal162 added this to the v1.3 milestone Nov 11, 2024
@github-actions github-actions bot added ui/ux Related with UI/UX design js Requires or modifies JavaScript code css Requires or modifies cascading style sheets fix Pull requests related to resolving problems or errors labels Nov 11, 2024
@Revathyvenugopal162 Revathyvenugopal162 marked this pull request as ready for review November 12, 2024 10:17
@Revathyvenugopal162 Revathyvenugopal162 requested a review from a team as a code owner November 12, 2024 10:17
@Revathyvenugopal162 @jorgepiloto
fix: no results banner
99df72e 
Co-authored-by: Jorge Martínez <[email protected]>
Revathyvenugopal162
Revathyvenugopal162 commented Nov 13, 2024
View reviewed changes
src/ansys_sphinx_theme/theme/ansys_sphinx_theme/static/js/search.js
function initializeFuse(data, options) {
fuse = new Fuse(data, options);
// add env variable "FUSE_ACTIVE" to indicate that the search is ready
document.documentElement.setAttribute("data-fuse_active", "true");
Copy link
Contributor Author

@Revathyvenugopal162 Revathyvenugopal162 Nov 13, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

https://github.com/ansys/ansys-sphinx-theme/pull/584/files#r1838131150 adding the value only if fuse.js initialize

jorgepiloto
jorgepiloto approved these changes Nov 13, 2024
View reviewed changes
Copy link
Member

@jorgepiloto jorgepiloto left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for adding this, @Revathyvenugopal162.

@Revathyvenugopal162
Copy link
Contributor Author

Revathyvenugopal162 commented Nov 13, 2024 •
edited
Loading

Thank you for reviewing @jorgepiloto , merging and performing a patch release

@Revathyvenugopal162 Revathyvenugopal162 merged commit 1544c84 into main Nov 13, 2024
21 checks passed
@Revathyvenugopal162 Revathyvenugopal162 deleted the fix/search-enter branch November 13, 2024 08:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@jorgepiloto jorgepiloto jorgepiloto approved these changes

Assignees

No one assigned

Labels

css Requires or modifies cascading style sheets fix Pull requests related to resolving problems or errors js Requires or modifies JavaScript code ui/ux Related with UI/UX design

Projects

None yet

Milestone

ansys-sphinx-theme v1.4

Development

Successfully merging this pull request may close these issues.

Searching doesn't work when opening HTML docs directly as files

4 participants

@Revathyvenugopal162 @jorgepiloto @pyansys-ci-bot