Skip to content

Commit

Permalink
Add an option to show the correct answer with a reveal button.
Browse files Browse the repository at this point in the history
Technically this does not add an option, but changes how the existing
showCorrectAnswers option in the PG environment works.  Previously it
was purely boolean.  Now it is numeric.

If it is zero, then correct answers are not shown (as before).

If it is 1, then correct answers are shown but hidden, and a "Reveal"
button is shown at first. If that button is clicked, then the answer is
shown.

If set to 2, then correct answers are shown immediately.
  • Loading branch information
drgrice1 committed Dec 8, 2023
1 parent f5192ad commit 37a95b5
Show file tree
Hide file tree
Showing 4 changed files with 79 additions and 9 deletions.
17 changes: 17 additions & 0 deletions htdocs/js/Feedback/feedback.js
Original file line number Diff line number Diff line change
Expand Up @@ -21,10 +21,27 @@
Array.from(origScript.attributes).forEach((attr) => newScript.setAttribute(attr.name, attr.value));
newScript.appendChild(document.createTextNode(origScript.innerHTML));
origScript.parentNode.replaceChild(newScript, origScript);
setTimeout(() => bsPopover.update());
});

// Make a click on the popover header close the popover.
bsPopover.tip?.querySelector('.popover-header')?.addEventListener('click', () => bsPopover?.hide());

const revealCorrectBtn = bsPopover.tip?.querySelector('.reveal-correct-btn');
revealCorrectBtn?.addEventListener('click', () => {
revealCorrectBtn.classList.add('fade-out');
revealCorrectBtn.parentElement.classList.add('resize-transition');
revealCorrectBtn.parentElement.style.maxWidth = `${revealCorrectBtn.parentElement.offsetWidth}px`;
revealCorrectBtn.parentElement.style.maxHeight = `${revealCorrectBtn.parentElement.offsetHeight}px`;
revealCorrectBtn.addEventListener('animationend', () => {
revealCorrectBtn.nextElementSibling?.classList.remove('d-none');
revealCorrectBtn.nextElementSibling?.classList.add('fade-in');
revealCorrectBtn.parentElement.style.maxWidth = '1000px';
revealCorrectBtn.parentElement.style.maxHeight = '1000px';
revealCorrectBtn.remove();
bsPopover.update();
});
});
});
};

Expand Down
33 changes: 33 additions & 0 deletions htdocs/js/Problem/problem.scss
Original file line number Diff line number Diff line change
Expand Up @@ -287,6 +287,39 @@
border-bottom-right-radius: var(--bs-card-inner-border-radius);
}
}

&.resize-transition {
overflow: clip;
transition: max-height 1s ease-in, max-width 1s ease-in;
}

.fade-out {
animation: fade-out 0.25s ease-in;

@keyframes fade-out {
0% {
opacity: 1;
}

100% {
opacity: 0;
}
}
}

.fade-in {
animation: fade-in 0.5s ease-in;

@keyframes fade-in {
0% {
opacity: 0;
}

100% {
opacity: 1;
}
}
}
}
}
}
Expand Down
7 changes: 5 additions & 2 deletions lib/WeBWorK/PG.pm
Original file line number Diff line number Diff line change
Expand Up @@ -513,9 +513,12 @@ The summary will also be generated if this is true.
Determines if any messages generated in answer evaluation will be shown.
=item showCorrectAnswers (boolean, default: 0)
=item showCorrectAnswers (numeric, default: 0)
Determines if correct answers will be shown.
Determines if correct answers will be shown. If 0, then correct answers are not
shown. If set to 1, then correct answers are shown but hidden, and a "Reveal"
button is shown at first. If that button is clicked, then the answer is shown.
If set to 2, then correct answers are shown immediately.
=item answerPrefix (string, default: '')
Expand Down
31 changes: 24 additions & 7 deletions macros/PG.pl
Original file line number Diff line number Diff line change
Expand Up @@ -902,8 +902,10 @@ =head2 ENDDOCUMENT
=item *
C<showCorrect>: This is a boolean value that is 1 by default. If this is true
and the translator option C<showCorrectAnswers> is also true, then a preview of
the correct answer is shown in the feedback popover.
and the translator option C<showCorrectAnswers> is nonzero, then a preview of
the correct answer is shown in the feedback popover. In other words, this option
prevents showing correct answers even if the frontend requests that correct
answers be shown.
=item *
Expand Down Expand Up @@ -1230,14 +1232,29 @@ sub ENDDOCUMENT {
)
. (
$rh_envir->{showCorrectAnswers} && $options{showCorrect}
? feedbackLine(
maketext('Correct Answer'),
previewAnswer(
? do {
my $correctAnswer = previewAnswer(
$ansHash->{correct_ans_latex_string},
$options{wrapPreviewInTex},
$ansHash->{correct_ans}
)
)
);
feedbackLine(
maketext('Correct Answer'),
$rh_envir->{showCorrectAnswers} > 1
? $correctAnswer
: Mojo::DOM->new_tag(
'button',
type => 'button',
class => 'reveal-correct-btn btn btn-secondary btn-sm',
maketext('Reveal')
)
. Mojo::DOM->new_tag(
'div',
class => 'd-none',
sub {$correctAnswer}
)
);
}
: ''
);
}
Expand Down

0 comments on commit 37a95b5

Please sign in to comment.