Skip to content

IMPROVE: Allow clicking on whole admonition title #29

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

Merged
choldgraf merged 6 commits into from
Feb 2, 2022
Merged

IMPROVE: Allow clicking on whole admonition title #29

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
8928e6c
Allow clicking on whole admonition title
rkdarst Dec 27, 2021
9498729
Add CSS for admonition title toggle
choldgraf Jan 25, 2022
3d7bdd6
Removing some div selectors to work with new docutils
choldgraf Jan 25, 2022
b8d7383
Simplify JS
choldgraf Feb 2, 2022
18f4051
More js
choldgraf Feb 2, 2022
cf74d36
Update sphinx_togglebutton/_static/togglebutton.js
choldgraf Feb 2, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 8 additions & 3 deletions sphinx_togglebutton/_static/togglebutton.css_t
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/* Visibility of the target */
.toggle, div.admonition.toggle .admonition-title ~ * {
.toggle, .admonition.toggle .admonition-title ~ * {
transition: opacity .5s, height .5s;
}

Expand All @@ -14,12 +14,12 @@
/* Overrides for admonition toggles */

/* Titles should cut off earlier to avoid overlapping w/ button */
div.admonition.toggle p.admonition-title {
.admonition.toggle p.admonition-title {
padding-right: 25%;
}

/* hides all the content of a page until de-toggled */
div.admonition.toggle-hidden .admonition-title ~ * {
.admonition.toggle-hidden .admonition-title ~ * {
height: 0;
margin: 0;
float: left; /* so they overlap when hidden */
Expand All @@ -32,6 +32,11 @@ div.admonition.toggle-hidden .admonition-title ~ * {
position: relative;
}

/* Clicking the title will toggle the admonition, so a pointer makes this clearer */
.toggle.admonition .admonition-title {
cursor: pointer;
}

.toggle.admonition.admonition-title:after {
content: "" !important;
}
Expand Down
9 changes: 8 additions & 1 deletion sphinx_togglebutton/_static/togglebutton.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,8 +24,15 @@ var initToggleItems = () => {
item.insertAdjacentHTML('beforebegin', collapseButton);
}

thisButton = $(`#${buttonID}`);
thisButton = document.getElementById(buttonID);
thisButton.on('click', toggleClickHandler);
// If admonition has a single direct-child title make it clickable.
admonitionTitle = document.querySelector(`#${toggleID} > .admonition-title`)
if (admonitionTitle) {
admonitionTitle.on('click', toggleClickHandler);
admonitionTitle.dataset.target = toggleID
admonitionTitle.dataset.button = buttonID
}
if (!item.classList.contains("toggle-shown")) {
toggleHidden(thisButton[0]);
}
Expand Down