Jts js qol #6057
Closed
Jts js qol #6057
Conversation
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
- Refactor main.js with a componentRegistry object and clear initialization of components and globals - Add a standard index.js with all necessary exports. - Update javascript.html to use the index.js - Remove jQuery script tag from header javascript.html (remains in footer) - Update package file to improve module discovery. - Improve Hugo and ESLint config for module discovery and ES6 syntax
…ooter.js. Exports jQuery ($) to a window global for use by other scripts. Scripts bundled into footer.js didn't reliably load after jQuery.
…to components and utilities. Conditionally imports Mermaid if page has a diagram.
…ound color for edgeLabel paragraph elements - Fixes dynamic loading of Mermaid.js - Adds MutationObserver to handle light/dark theme switching. - Sets the background-color for edgeLabel p elements to override a white background that obscures text in the dark theme.
1. Refactor JavaScript from search.html into a new DocSearch Component Module. The component needs to include: - Asynchronous loading of Algolia docsearch.min.js - Proper Algolia search facets: - Nested arrays for AND conditions: In Algolia, filters in the same array are combined with OR, while arrays in an array are combined with AND - Space after colon: Algolia's parser expects this specific format 2. Update Search HTML Template: refactor the search.html to use the new component: 3. Register the Component in main.js: update main.js to import and register our new DocSearch component: Improve SearchInteractions event handler coordination with DocSearch: - Improve SearchInteractions to dynamically detect the dropdown added by Algolia DocSearch and ensure that blur and focus event handlers are registered after the dropdown loads. Benefits of This Approach: Asynchronous Loading: DocSearch.js is now loaded asynchronously, improving page load performance Search functionality is encapsulated as a component Clean Separation: HTML template only contains configuration data, not implementation Event Communication: Components can react to DocSearch initialization via events SearchInteractions dynamically detects dropdown: Instead of waiting for an event or using setTimeout, we actively observe DOM changes to detect when the dropdown is created. Nested Observation: A second observer monitors changes to the dropdown itself, allowing code to respond to style changes. Better Event Handling: The blur handler checks if the related target is inside the search components, preventing unwanted dropdown closing. Resource Cleanup: The cleanup function disconnects all observers, preventing memory leaks. Additional Interaction Control: Adds an event listener to the dropdown to prevent unwanted blur events when interacting with search results.
…ion method - Extracted platform detection to its own reusable utility module - Eliminates deprecated Navigator.platform API usage; uses the User-Agent Client Hints API as the primary method when available - Handles iOS and Android devices correctly
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.
Closes #
Describe your proposed changes here.
(if necessary)
Theming fix:
ThemeSwitch() should pass the component when calling Theme().
Optimize Mermaid using dynamic loading.
fix(diagram): Mermaid.js: dynamic loading, support dark theme, background color for edgeLabel paragraph elements
- Fixes dynamic loading of Mermaid.js
- Adds MutationObserver to handle light/dark theme switching.
- Sets the background-color for edgeLabel p elements to override a white background that obscures text in the dark theme.
Refactor feature-callout to a component
Moved to a component, but it appears to be unused? Do we still need it?
Refactor keybindings to a component and replace deprecated detection method
utils/user-agent-platformreusable utility moduleRefactor Flux group keys demo to a component
Refactor datetime to module file
Moves datetime.js to a (non-component) module file
Refactor release-toc to component
Moves release-toc.js to a ReleaseToc component module.
Optimize and improve loading the search script
Refactor Algolia search to component and use async loading of docsearch.min.js:
e2e test runner
1315, runs Cypress tests, and then stops Hugo--specand file list arguments as Cypress.Test shared files
map-files-to-urls.mjsreceives acontent/sharedfile it:source:attribute and adds the pages to the list of files to test.content/sharedfiles directly.Overhaul link checker
Add
test-onlyfrontmatter attributetest-onlyattribute for files likeexample.md. Don't usedraft: truefor these files.index.htmlfor the attribute so that the files are only rendered when running in thetestingenvironment.