Skip to content
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

Jump to bottom

Collapse example code blocks in challenge descriptions #54561

Open
wants to merge 5 commits into
base: main
Choose a base branch
from
+42 −0
Open

Collapse example code blocks in challenge descriptions #54561

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
872856c
update css to fix space rendering
suyeon-cha Apr 27, 2024
1a0d847
undo change in main branch
suyeon-cha Apr 27, 2024
d4bac93
make code examples collapsible
jhong66 Apr 28, 2024
45c1e88
add styling tags
jhong66 Apr 28, 2024
c653c0e
fix: example code dropdown button style
ndaruvala Apr 28, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
10 changes: 10 additions & 0 deletions client/src/templates/Challenges/classic/editor.css
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -193,6 +193,16 @@ textarea.inputarea {
margin-bottom: 18px;
}

.code-details {
font-weight: 700;
margin-bottom: 0.6rem;
}

.code-details-summary {
display: list-item;
cursor: pointer;
}

/* overwriting default arrow styles for accessibility */
:root {
--monaco-scrollbar-arrow-box-size: 0;
Expand Down
2 changes: 2 additions & 0 deletions client/src/templates/Challenges/classic/editor.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,7 @@ import {
import GreenPass from '../../../assets/icons/green-pass';
import {
enhancePrismAccessibility,
makePrismCollapsible,
setScrollbarArrowStyles
} from '../utils/index';
import { initializeMathJax } from '../../../utils/math-jax';
Expand Down Expand Up @@ -807,6 +808,7 @@ const Editor = (props: EditorProps): JSX.Element => {
descContainer.appendChild(desc);
desc.innerHTML = description;
Prism.hooks.add('complete', enhancePrismAccessibility);
Prism.hooks.add('complete', makePrismCollapsible);
Prism.highlightAllUnder(desc);

domNode.style.userSelect = 'text';
Expand Down
30 changes: 30 additions & 0 deletions client/src/templates/Challenges/utils/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75,6 +75,36 @@ export function enhancePrismAccessibility(
);
}

// Make PrismJS code blocks collapsible
export function makePrismCollapsible(
prismEnv: Prism.hooks.ElementHighlightedEnvironment
): void {
const preElem = prismEnv?.element?.parentElement;
const sectionElem = preElem?.parentElement;
if (
!preElem ||
preElem.nodeName !== 'PRE' ||
preElem.tabIndex !== 0 ||
!sectionElem ||
sectionElem.nodeName !== 'SECTION'
) {
return;
}

const details = document.createElement('details');
details.classList.add('code-details');

const summary = document.createElement('summary');
summary.classList.add('code-details-summary');
summary.innerHTML = 'Example Code';

details.appendChild(summary);
details.appendChild(preElem.cloneNode(true));
details.open = true;

sectionElem.replaceChild(details, preElem);
}

// Adjusts scrollbar arrows based on scrollbar width
export function setScrollbarArrowStyles(scrollbarWidth: number): void {
const root = document.documentElement;
Expand Down