Add glossary tooltip feature #681
Merged
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
Swizzle component to add glossary tooltip function.
Ignore `/static/glossary.json` since we only need it when building the site in production.
josh-wong
changed the title
josh-wong
force-pushed
the
add-definition-tooltip-feature
branch
from
d6232ee to
aa56164
Compare
✅ Deploy Preview for staging-scalardb-docs-site canceled.
|
On desktop: Increase padding around definitions. On mobile: Add styles to keep the tooltip within view on narrow screens.
To avoid confusion with the glossary tooltip, this commit clarifies the naming for the tooltip for the question mark icon in the header that contains version and edition tags.
❌ Deploy Preview for staging-scalardb-docs-site failed. Why did it fail? →
|
josh-wong
added a commit
that referenced
this pull request
May 14, 2025
* Create index.tsx Swizzle component to add glossary tooltip function. * Add glossary tooltip function * Add styles for glossary tooltip * Add `scripts/generate-glossary-json.js` to build step * Add `/static/glossary.json` Ignore `/static/glossary.json` since we only need it when building the site in production. * Create GlossaryInjector.tsx * Create GlossaryTooltip.tsx * Create generate-glossary-json.js * Remove unnecessary ignore * Put glossary tooltip styles in ABC order * Refactor code to support tooltips in en-us and ja-jp * Enable i18n * Remove unnecessary code comments * Fix rendering of glossary tooltip On desktop: Increase padding around definitions. On mobile: Add styles to keep the tooltip within view on narrow screens. * Update naming for other tooltip style To avoid confusion with the glossary tooltip, this commit clarifies the naming for the tooltip for the question mark icon in the header that contains version and edition tags.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Description
This PR adds a tooltip feature that shows the definition of terms from our glossary.
The tooltip appears on only the first mention within the content of the doc, whether it's in a paragraph, ordered or unordered list, or table. The tooltip doesn't appear in headings, links, or code blocks.
In addition, the tooltip shows English definitions on English pages and Japanese definitions on Japanese pages.
Note
The glossary tooltip feature appears only in production environments.
Related issues and/or PRs
Changes made
glossary.mdxdocs in the folder for the latest release.Checklist
N/AN/AAdditional notes (optional)
N/A