Infra: update canonical banners to not stick on small screens (#3559)

Updates small media sizes to not have a sticky banner
Adds a helper close button to optionally close banner

Closes #3536
This commit is contained in:
Jacob Coffee 2023-12-03 00:31:13 -06:00 committed by GitHub
parent 2d1bdc5cf5
commit ff0702ebfc
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 37 additions and 0 deletions

View File

@ -34,6 +34,9 @@ class PEPBanner(rst.Directive):
else: else:
pre_text = self.admonition_pre_text pre_text = self.admonition_pre_text
close_button_node = nodes.paragraph('', '', nodes.Text('×'), classes=['close-button'])
close_button_node['classes'].append('close-button')
pre_text_node = nodes.paragraph(pre_text) pre_text_node = nodes.paragraph(pre_text)
pre_text_node.line = self.lineno pre_text_node.line = self.lineno
pre_node, pre_msg = self.state.inline_text(pre_text, self.lineno) pre_node, pre_msg = self.state.inline_text(pre_text, self.lineno)
@ -50,6 +53,7 @@ class PEPBanner(rst.Directive):
"\n".join(source_lines), classes=["pep-banner"] + self.css_classes) "\n".join(source_lines), classes=["pep-banner"] + self.css_classes)
admonition_node.append(pre_text_node) admonition_node.append(pre_text_node)
admonition_node.append(close_button_node)
if self.content: if self.content:
self.state.nested_parse( self.state.nested_parse(
self.content, self.content_offset, admonition_node) self.content, self.content_offset, admonition_node)

View File

@ -22,6 +22,16 @@ document.addEventListener("DOMContentLoaded", () => {
node.replaceChildren(text); node.replaceChildren(text);
} }
const closeButton = document.querySelector('.close-button');
if (closeButton) {
closeButton.addEventListener('click', () => {
const stickyBanner = document.querySelector('.sticky-banner');
if (stickyBanner) {
stickyBanner.style.display = 'none';
}
});
}
adjustBannerMargin(); adjustBannerMargin();
document.addEventListener("resize", adjustBannerMargin); document.addEventListener("resize", adjustBannerMargin);
document.addEventListener("load", adjustBannerMargin); document.addEventListener("load", adjustBannerMargin);

View File

@ -407,8 +407,31 @@ dl.footnote > dd {
} }
/* Sticky banners */ /* Sticky banners */
/* Default styles, sticky for larger screens */
.sticky-banner { .sticky-banner {
top: 0; top: 0;
position: sticky; position: sticky;
z-index: 1; z-index: 1;
} }
/* Override for smaller screens, non-sticky */
@media (max-width: 600px) {
.sticky-banner {
position: static;
padding: 5px;
font-size: 12px;
}
}
.close-button {
cursor: pointer;
position: absolute;
top: 0;
right: 0;
padding: 0.5em;
font-size: 1.5em;
border: none;
background: transparent;
color: inherit;
margin-top: 0;
}