-
Notifications
You must be signed in to change notification settings - Fork 60
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
✨ NEW: sync tabs by URL query parameters (#196)
Synchronised tabs can now be selected by adding a query parameter to the URL, for that sync-group, such as `?code=python` for
```restructuredtext
.. tab-set-code::
.. literalinclude:: snippet.py
:language: python
.. literalinclude:: snippet.js
:language: javascript
```
The last selected tab key, per group, is also persisted to `SessionStroage`
Co-authored-by: Mike McKiernan <mmckiernan@nvidia.com>- Loading branch information
1 parent
a6f97b8
commit f1427ce
Showing
12 changed files
with
179 additions
and
32 deletions.
There are no files selected for viewing
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 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 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 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 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 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 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,27 +1,101 @@ | ||
| var sd_labels_by_text = {}; | ||
| // @ts-check | ||
|
|
||
| // Extra JS capability for selected tabs to be synced | ||
| // The selection is stored in local storage so that it persists across page loads. | ||
|
|
||
| /** | ||
| * @type {Record<string, HTMLElement[]>} | ||
| */ | ||
| let sd_id_to_elements = {}; | ||
| const storageKeyPrefix = "sphinx-design-tab-id-"; | ||
|
|
||
| /** | ||
| * Create a key for a tab element. | ||
| * @param {HTMLElement} el - The tab element. | ||
| * @returns {[string, string, string] | null} - The key. | ||
| * | ||
| */ | ||
| function create_key(el) { | ||
| let syncId = el.getAttribute("data-sync-id"); | ||
| let syncGroup = el.getAttribute("data-sync-group"); | ||
| if (!syncId || !syncGroup) return null; | ||
| return [syncGroup, syncId, syncGroup + "--" + syncId]; | ||
| } | ||
|
|
||
| /** | ||
| * Initialize the tab selection. | ||
| * | ||
| */ | ||
| function ready() { | ||
| const li = document.getElementsByClassName("sd-tab-label"); | ||
| for (const label of li) { | ||
| syncId = label.getAttribute("data-sync-id"); | ||
| if (syncId) { | ||
| label.onclick = onSDLabelClick; | ||
| if (!sd_labels_by_text[syncId]) { | ||
| sd_labels_by_text[syncId] = []; | ||
| // Find all tabs with sync data | ||
|
|
||
| /** @type {string[]} */ | ||
| let groups = []; | ||
|
|
||
| document.querySelectorAll(".sd-tab-label").forEach((label) => { | ||
| if (label instanceof HTMLElement) { | ||
| let data = create_key(label); | ||
| if (data) { | ||
| let [group, id, key] = data; | ||
|
|
||
| // add click event listener | ||
| // @ts-ignore | ||
| label.onclick = onSDLabelClick; | ||
|
|
||
| // store map of key to elements | ||
| if (!sd_id_to_elements[key]) { | ||
| sd_id_to_elements[key] = []; | ||
| } | ||
| sd_id_to_elements[key].push(label); | ||
|
|
||
| if (groups.indexOf(group) === -1) { | ||
| groups.push(group); | ||
| // Check if a specific tab has been selected via URL parameter | ||
| const tabParam = new URLSearchParams(window.location.search).get( | ||
| group | ||
| ); | ||
| if (tabParam) { | ||
| console.log( | ||
| "sphinx-design: Selecting tab id for group '" + | ||
| group + | ||
| "' from URL parameter: " + | ||
| tabParam | ||
| ); | ||
| window.sessionStorage.setItem(storageKeyPrefix + group, tabParam); | ||
| } | ||
| } | ||
|
|
||
| // Check is a specific tab has been selected previously | ||
| let previousId = window.sessionStorage.getItem( | ||
| storageKeyPrefix + group | ||
| ); | ||
| if (previousId === id) { | ||
| // console.log( | ||
| // "sphinx-design: Selecting tab from session storage: " + id | ||
| // ); | ||
| // @ts-ignore | ||
| label.previousElementSibling.checked = true; | ||
| } | ||
| } | ||
| sd_labels_by_text[syncId].push(label); | ||
| } | ||
| } | ||
| }); | ||
| } | ||
|
|
||
| /** | ||
| * Activate other tabs with the same sync id. | ||
| * | ||
| * @this {HTMLElement} - The element that was clicked. | ||
| */ | ||
| function onSDLabelClick() { | ||
| // Activate other inputs with the same sync id. | ||
| syncId = this.getAttribute("data-sync-id"); | ||
| for (label of sd_labels_by_text[syncId]) { | ||
| let data = create_key(this); | ||
| if (!data) return; | ||
| let [group, id, key] = data; | ||
| for (const label of sd_id_to_elements[key]) { | ||
| if (label === this) continue; | ||
| // @ts-ignore | ||
| label.previousElementSibling.checked = true; | ||
| } | ||
| window.localStorage.setItem("sphinx-design-last-tab", syncId); | ||
| window.sessionStorage.setItem(storageKeyPrefix + group, id); | ||
| } | ||
|
|
||
| document.addEventListener("DOMContentLoaded", ready, false); |
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 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 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 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
Oops, something went wrong.