MOBILE-4283 quiz: Allow students to hide timer

moodlehq · Jul 7, 2023 · 573af7c · 573af7c
1 parent 670bb10
commit 573af7c
Show file tree

Hide file tree

Showing 8 changed files with 104 additions and 71 deletions.
diff --git a/src/addons/mod/assign/components/submission/submission.scss b/src/addons/mod/assign/components/submission/submission.scss
@@ -27,15 +27,15 @@
         margin-right: 2px;
     }
 
-    core-timer .core-timer {
+    core-timer {
         &.core-timer-under-300 {
-            background-color: var(--danger-tint);
-            color: var(--danger-shade);
+            --timer-background: var(--danger-tint);
+            --timer-text-color: var(--danger-shade);
         }
 
         &.core-timer-under-900 {
-            background-color: var(--warning-tint);
-            color: var(--warning-shade);
+            --timer-background: var(--warning-tint);
+            --timer-text-color: var(--warning-shade);
         }
     }
 }

diff --git a/src/addons/mod/assign/pages/edit/edit.html b/src/addons/mod/assign/pages/edit/edit.html
@@ -22,7 +22,7 @@ <h1>
             <!-- @todo plagiarism_print_disclosure -->
             <core-timer *ngIf="timeLimitEndTime > 0" [endTime]="timeLimitEndTime" (finished)="timeUp()" timeUpText="00:00:00"
                 [timerText]="'addon.mod_assign.assigntimeleft' | translate" [align]="'center'" [timeLeftClassThreshold]="-1"
-                [underTimeClassThresholds]="[300, 900]" class="ion-margin-horizontal">
+                [underTimeClassThresholds]="[300, 900]">
             </core-timer>
 
             <!-- Assign activity instructions and attachments if needed. -->

diff --git a/src/addons/mod/assign/pages/edit/edit.scss b/src/addons/mod/assign/pages/edit/edit.scss
@@ -1,17 +1,13 @@
-:host ::ng-deep {
+:host {
     core-timer {
-        display: block;
-
-        .core-timer {
-            &.core-timer-under-300 {
-                background-color: var(--danger-tint);
-                color: var(--danger-shade);
-            }
+        &.core-timer-under-300 {
+            --timer-background: var(--danger-tint);
+            --timer-text-color: var(--danger-shade);
+        }
 
-            &.core-timer-under-900 {
-                background-color: var(--warning-tint);
-                color: var(--warning-shade);
-            }
+        &.core-timer-under-900 {
+            --timer-background: var(--warning-tint);
+            --timer-text-color: var(--warning-shade);
         }
     }
 }
diff --git a/src/addons/mod/quiz/pages/player/player.html b/src/addons/mod/quiz/pages/player/player.html
@@ -22,13 +22,9 @@ <h1>
             </ion-button>
         </ion-buttons>
     </ion-toolbar>
-    <!-- Navigation arrows and time left. -->
-    <ion-toolbar *ngIf="loaded && endTime && questions.length && !quizAborted && !showSummary" color="light">
-        <ion-title>
-            <core-timer [endTime]="endTime" (finished)="timeUp()" [timerText]="'addon.mod_quiz.timeleft' | translate" [align]="'center'">
-            </core-timer>
-        </ion-title>
-    </ion-toolbar>
+    <core-timer *ngIf="loaded && endTime && questions.length && !quizAborted && !showSummary" [endTime]="endTime" (finished)="timeUp()"
+        [timerText]="'addon.mod_quiz.timeleft' | translate" [hiddable]="true">
+    </core-timer>
 </ion-header>
 <ion-content class="limited-width">
     <core-loading [hideUntil]="loaded" class="has-spacer">

diff --git a/src/addons/mod/quiz/pages/player/player.scss b/src/addons/mod/quiz/pages/player/player.scss
@@ -9,22 +9,14 @@ $quiz-timer-iterations: 15 !default;
         margin-bottom: 2px;
     }
 
-    ion-content ion-toolbar {
-        border-bottom: 1px solid var(--stroke);
-    }
-
-    core-timer ::ng-deep {
-        .core-timer {
-            // Make the timer go red when it's reaching 0.
-            @for $i from 0 through $quiz-timer-iterations {
-                &.core-timer-timeleft-#{$i} {
-                    background-color: rgba($quiz-timer-warn-color, 1 - ($i / $quiz-timer-iterations)) !important;
-
-                    @if $i <= $quiz-timer-iterations / 2 {
-                        label, span, ion-icon {
-                            color: var(--white);
-                        }
-                    }
+    core-timer {
+        // Make the timer go red when it's reaching 0.
+        @for $i from 0 through $quiz-timer-iterations {
+            &.core-timer-timeleft-#{$i} {
+                $timer-background: rgba($quiz-timer-warn-color, 1 - ($i / $quiz-timer-iterations));
+                --timer-background: #{$timer-background};
+                @if $i <= $quiz-timer-iterations / 2 {
+                    --timer-text-color: var(--white);
                 }
             }
         }

diff --git a/src/core/components/timer/core-timer.html b/src/core/components/timer/core-timer.html
@@ -1,21 +1,32 @@
-<ion-item *ngIf="mode !== modeBasic" class="core-timer" role="timer"
-    [ngClass]="{'ion-text-center': align == 'center', 'ion-text-end': align == 'right'}">
-    <ion-icon name="fas-clock" slot="start" aria-hidden="true"></ion-icon>
-    <ion-label>
+<ng-container *ngIf="timeLeft !== undefined">
+    <ion-item *ngIf="mode !== modeBasic" class="core-timer" role="timer" [attr.aria-label]="timerText">
+        <ion-label class="ion-justify-content-{{align}}">
+            <ng-container *ngTemplateOutlet="timerTemplate"></ng-container>
+        </ion-label>
+    </ion-item>
+
+    <div *ngIf="mode === modeBasic" class="core-timer ion-padding ion-justify-content-{{align}}" role="timer" [attr.aria-label]="timerText">
         <ng-container *ngTemplateOutlet="timerTemplate"></ng-container>
-    </ion-label>
-</ion-item>
+    </div>
+
+    <ng-template #timerTemplate>
+        <ng-container *ngIf="timeLeft > 0">
+            <div class="ion-text-wrap">
+                <span *ngIf="timerText" class="core-timer-text">{{ timerText }}</span>
+                <span *ngIf="showTimeLeft" class="core-timer-time-left">
+                    {{ timeLeft | coreSecondsToHMS }}
+                </span>
+            </div>
 
-<div *ngIf="mode === modeBasic" class="core-timer ion-padding" role="timer"
-    [ngClass]="{'ion-text-center': align == 'center', 'ion-text-end': align == 'right'}">
-    <ng-container *ngTemplateOutlet="timerTemplate"></ng-container>
-</div>
+            <div *ngIf="hiddable" class="core-timer-visibility">
+                ( <button class="as-link" *ngIf="showTimeLeft" (click)="toggleTimeLeftVisibility()">{{ 'core.hide' | translate }}</button>
+                <button class="as-link" *ngIf="!showTimeLeft" (click)="toggleTimeLeftVisibility()">{{ 'core.show' | translate }}</button> )
+            </div>
+        </ng-container>
 
-<ng-template #timerTemplate>
-    <span *ngIf="timerText" class="core-timer-text">{{ timerText }}</span>
-    <span *ngIf="timeLeft && timeLeft > 0" class="core-timer-time-left">{{ timeLeft | coreSecondsToHMS }}</span>
-    <span class="core-timesup" *ngIf="timeLeft !== undefined && timeLeft <= 0">
-        <ng-container *ngIf="timeUpText">{{ timeUpText }}</ng-container>
-        <ng-container *ngIf="!timeUpText">{{ 'core.timesup' | translate }}</ng-container>
-    </span>
-</ng-template>
+        <div class="core-timesup" *ngIf="timeLeft <= 0">
+            <ng-container *ngIf="timeUpText">{{ timeUpText }}</ng-container>
+            <ng-container *ngIf="!timeUpText">{{ 'core.timesup' | translate }}</ng-container>
+        </div>
+    </ng-template>
+</ng-container>
diff --git a/src/core/components/timer/timer.scss b/src/core/components/timer/timer.scss
@@ -1,14 +1,40 @@
 :host {
-    .core-timer {
-        --background: transparent !important;
-        border-radius: var(--big-radius);
+    --timer-background: transparent;
 
+    .core-timer {
         .core-timer-time-left, .core-timesup {
             font-weight: bold;
         }
 
-        span {
-            margin-right: 5px;
+        .core-timesup {
+            flex-grow: 1;
+            text-align: center;
+        }
+    }
+
+    ion-item.core-timer {
+        --background: var(--timer-background);
+        --color: var(--timer-text-color, var(--text-color));
+    }
+
+    div.core-timer {
+        background: var(--timer-background);
+        color: var(--timer-text-color, var(--text-color));
+        border-radius: var(--big-radius);
+    }
+
+    button {
+        color: var(--timer-text-color, var(--core-link-color));
+    }
+
+    ion-item.core-timer ion-label,
+    div.core-timer {
+        display: flex;
+        align-items: center;
+
+        .core-timer-visibility {
+            flex-grow: 1;
+            text-align: end;
         }
     }
 }
diff --git a/src/core/components/timer/timer.ts b/src/core/components/timer/timer.ts
@@ -29,18 +29,20 @@ import { CoreTimeUtils } from '@services/utils/time';
 })
 export class CoreTimerComponent implements OnInit, OnDestroy {
 
-    @Input() endTime?: string | number; // Timestamp (in seconds) when the timer should end.
+    @Input() endTime = 0; // Timestamp (in seconds) when the timer should end.
     @Input() timerText?: string; // Text to show next to the timer. If not defined, no text shown.
     @Input() timeLeftClass?: string; // Name of the class to apply with each second. By default, 'core-timer-timeleft-'.
     @Input() timeLeftClassThreshold = 100; // Number of seconds to start adding the timeLeftClass. Set it to -1 to not add it.
-    @Input() align?: string; // Where to align the time and text. Defaults to 'left'. Other values: 'center', 'right'.
+    @Input() align = 'start'; // Where to align the time and text. Defaults to 'start'. Other values: 'center', 'end'.
+    @Input() hiddable = false; // Whether the user can hide the time left.
     @Input() timeUpText?: string; // Text to show when the timer reaches 0. If not defined, 'core.timesup'.
     @Input() mode: CoreTimerMode = CoreTimerMode.ITEM; // How to display data.
     @Input() underTimeClassThresholds = []; // Number of seconds to add the class 'core-timer-under-'.
     @Output() finished = new EventEmitter<void>(); // Will emit an event when the timer reaches 0.
 
     timeLeft?: number; // Seconds left to end.
     modeBasic = CoreTimerMode.BASIC;
+    showTimeLeft = true;
 
     protected timeInterval?: number;
     protected element?: HTMLElement;
@@ -54,18 +56,21 @@ export class CoreTimerComponent implements OnInit, OnDestroy {
      */
     ngOnInit(): void {
         const timeLeftClass = this.timeLeftClass || 'core-timer-timeleft-';
-        const endTime = Math.round(Number(this.endTime));
+        const endTime = Math.round(this.endTime);
         this.underTimeClassThresholds.sort((a, b) => a - b); // Sort by increase order.
 
-        if (!endTime) {
-            return;
+        // @deprecated since 4.3. Use start/end instead.
+        if (this.align === 'left') {
+            this.align = 'start';
+        } else if (this.align === 'right') {
+            this.align = 'end';
         }
 
         let container: HTMLElement | undefined;
 
         // Check time left every 200ms.
         this.timeInterval = window.setInterval(() => {
-            container = container || this.elementRef.nativeElement.querySelector('.core-timer');
+            container = container || this.elementRef.nativeElement;
             this.timeLeft = Math.max(endTime - CoreTimeUtils.timestamp(), 0);
 
             if (container) {
@@ -104,7 +109,14 @@ export class CoreTimerComponent implements OnInit, OnDestroy {
     }
 
     /**
-     * Component destroyed.
+     * Toggles the time left visibility.
+     */
+    toggleTimeLeftVisibility(): void {
+        this.showTimeLeft = !this.showTimeLeft;
+    }
+
+    /**
+     * @inheritdoc
      */
     ngOnDestroy(): void {
         clearInterval(this.timeInterval);