Skip to content

Use admonitions to style collapsible cells :) #656

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
bsipocz merged 4 commits into from
Apr 25, 2025
Merged

Use admonitions to style collapsible cells :) #656

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
03b3120
Use admonitions to style collapsible cells :)
sneakers-the-rat Jan 31, 2025
3f5ee68
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] Jan 31, 2025
b8219a1
Merge branch 'master' into code-cells-admonition
bsipocz Apr 24, 2025
7f3479f
Merge branch 'master' into code-cells-admonition
bsipocz Apr 25, 2025
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
10 changes: 7 additions & 3 deletions myst_nb/sphinx_.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -492,10 +492,14 @@ def add_to_app(cls, app: Sphinx):

def visit_HideCellInput(self: SphinxTranslator, node: HideCodeCellNode):
classes = " ".join(node["classes"])
self.body.append(f'<details class="hide {classes}">\n')
self.body.append(f'<details class="admonition hide {classes}">\n')
self.body.append('<summary aria-label="Toggle hidden content">\n')
self.body.append(f'<span class="collapsed">{escape(node["prompt_show"])}</span>\n')
self.body.append(f'<span class="expanded">{escape(node["prompt_hide"])}</span>\n')
self.body.append(
f'<p class="collapsed admonition-title">{escape(node["prompt_show"])}</p>\n'
)
self.body.append(
f'<p class="expanded admonition-title">{escape(node["prompt_hide"])}</p>\n'
)
self.body.append("</summary>\n")


Expand Down
88 changes: 52 additions & 36 deletions myst_nb/static/mystnb.css
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,8 +40,7 @@ div.container.cell {
}

/* Input cells */
div.cell div.cell_input,
div.cell details.above-input>summary {
div.cell > div.cell_input {
padding-left: 0em;
padding-right: 0em;
border: var(--mystnb-source-border-width) var(--mystnb-source-border-color) solid;
Expand Down Expand Up @@ -90,57 +89,69 @@ div.cell_output div.output>div.highlight {
border: 1px solid var(--mystnb-traceback-border-color);
}

/* Collapsible cell content */
div.cell details.above-input div.cell_input {
border-top-left-radius: 0;
border-top-right-radius: 0;
border-top: var(--mystnb-source-border-width) var(--mystnb-source-border-color) dashed;
/* --- Collapsible cell content --- */

/*
encourage summary container to blend in with its parent.
p.admonition-title should hold the title styles.
*/
div.cell details.hide summary {
border-left: unset;
padding: inherit;
margin: inherit;
background-color: inherit;
}

div.cell div.cell_input.above-output-prompt {
border-bottom-left-radius: 0;
border-bottom-right-radius: 0;
/* Neighboring input/output elements - spacing, borders */
div.cell details.hide.above-input + details.below-input,
div.cell div.cell_input + details.below-input
{
margin-top: 0;
}

div.cell details.hide.above-input:has(+ details.below-input),
div.cell div.cell_input:has(+ details.below-input)
{
margin-bottom: 0;
}

div.cell details.above-input>summary {
div.cell:has(> *:nth-child(2)) div.cell_input:first-child,
div.cell:has(> *:nth-child(2)) details:first-child
{
border-bottom-left-radius: 0;
border-bottom-right-radius: 0;
border-bottom: var(--mystnb-source-border-width) var(--mystnb-source-border-color) dashed;
padding-left: 1em;
margin-bottom: 0;
}

div.cell details.above-output>summary {
background-color: var(--mystnb-source-bg-color);
padding-left: 1em;
padding-right: 0em;
border: var(--mystnb-source-border-width) var(--mystnb-source-border-color) solid;
border-radius: var(--mystnb-source-border-radius);
border-left-color: var(--mystnb-source-margin-color);
border-left-width: medium;
div.cell:has(> *:nth-child(2)) div.cell_input:last-child,
div.cell:has(> *:nth-child(2)) details:last-child
{
border-top-left-radius: 0;
border-top-right-radius: 0;
}

div.cell details.below-input>summary {
background-color: var(--mystnb-source-bg-color);
padding-left: 1em;
padding-right: 0em;
border: var(--mystnb-source-border-width) var(--mystnb-source-border-color) solid;
border-top: none;
border-bottom-left-radius: var(--mystnb-source-border-radius);
border-bottom-right-radius: var(--mystnb-source-border-radius);
border-left-color: var(--mystnb-source-margin-color);
border-left-width: medium;
/* intra-label styles for collapsibles */
div.cell.container details.hide.above-input>summary,
div.cell.container details.hide.below-input>summary,
div.cell.container details.hide.above-output>summary
{
display: block;
border-left: none;
}

div.cell details.hide>summary>span {
opacity: var(--mystnb-hide-prompt-opacity);
div.cell details.hide>summary>p.admonition-title {
display: list-item;
margin-bottom: 0;
}

div.cell details.hide[open]>summary>span.collapsed {
div.cell details.hide:not([open]) {
padding-bottom: 0;
}

div.cell details.hide[open]>summary>p.collapsed {
display: none;
}

div.cell details.hide:not([open])>summary>span.expanded {
div.cell details.hide:not([open])>summary>p.expanded {
display: none;
}

Expand All @@ -159,6 +170,11 @@ div.cell details.hide[open]>summary~* {
animation: collapsed-fade-in 0.3s ease-in-out;
}

/* Clear conflicting styles for details and admonitions set by some themes */
div.cell details.admonition summary::before {
content: unset;
}

/* Math align to the left */
.cell_output .MathJax_Display {
text-align: left !important;
Expand Down
⚡