@nxgt/material 3.55.0 → 3.57.0

package/dist/lib/components/ui/widgets/education/navigator/index.d.ts

@@ -0,0 +1,2 @@
+export type { QuestionNavigatorProps } from './question-navigator.js';
+export { QuestionNavigator } from './question-navigator.js';

package/dist/lib/components/ui/widgets/education/navigator/partials/navigator-item.d.ts

@@ -0,0 +1,10 @@
+export type NavigatorItemProps = {
+    n: number;
+    current: boolean;
+    answered: boolean;
+    flagged: boolean;
+    onSelect?: (n: number) => void;
+    href?: string;
+};
+/** One numbered target: a link, a button or a plain mark. */
+export declare function NavigatorItem({ n, current, answered, flagged, onSelect, href, }: NavigatorItemProps): import("react").JSX.Element;

package/dist/lib/components/ui/widgets/education/navigator/question-navigator.d.ts

@@ -0,0 +1,27 @@
+import { ComponentProps } from 'react';
+type NumberSet = ReadonlyArray<number> | ReadonlySet<number>;
+export type QuestionNavigatorProps = {
+    /** How many questions. */
+    count: number;
+    /** The current question, from 1. */
+    current: number;
+    /** The answered questions, from 1. */
+    answered?: NumberSet;
+    /** The questions marked for review, from 1. */
+    flagged?: NumberSet;
+    /** Makes each number a button; receives the question number, from 1. */
+    onSelect?: (n: number) => void;
+    /** Makes each number a link (a URL-driven player); wins over `onSelect`. */
+    getHref?: (n: number) => string;
+    /** The list's name; "Questions" by default. */
+    label?: string;
+} & Omit<ComponentProps<'nav'>, 'onSelect'>;
+/**
+ * The numbered questions of a quiz or exam: jump to one, see the current one
+ * and which are answered or flagged. One scrolling row that keeps the current
+ * number in view, so 20 or 100 questions stay compact on a 360px phone. Each
+ * target is at least 44px; answered and flagged show an icon and are named in
+ * the accessible label, never by colour alone. Questions are numbered from 1.
+ */
+export declare function QuestionNavigator({ count, current, answered, flagged, onSelect, getHref, label, className, ...props }: QuestionNavigatorProps): import("react").JSX.Element;
+export {};

package/dist/lib/components/ui/widgets/education/questions/index.d.ts

@@ -1,3 +1,3 @@
 export { QuestionCard } from './question.js';
 export { answerParts, isAnswerCorrect, isAnswered, parseAnswerNumber, } from './question.utils.js';
-export type { Question, QuestionAnswer, QuestionImage, QuestionKind, QuestionOption, QuestionProps, } from './types.js';
+export type { Question, QuestionAnswer, QuestionImage, QuestionKind, QuestionMedia, QuestionMediaKind, QuestionOption, QuestionPoints, QuestionProps, QuestionVerdict, } from './types.js';

package/dist/lib/components/ui/widgets/education/questions/partials/question-media.d.ts

@@ -0,0 +1,5 @@
+import { QuestionMedia as Media } from '../types.js';
+/** What goes with the prompt: a picture, an audio clip or a document link. */
+export declare function QuestionMedia({ media }: {
+    media: Media;
+}): import("react").JSX.Element;

package/dist/lib/components/ui/widgets/education/questions/partials/question-verdict.d.ts

@@ -0,0 +1,12 @@
+import { Question, QuestionPoints, QuestionVerdict as Verdict } from '../types.js';
+/**
+ * The verdict the server gave, as given: the word and an icon (never colour
+ * alone), the points, the grader's remark, the correct answer when one is
+ * passed and the answer was wrong, and the explanation.
+ */
+export declare function QuestionVerdict({ question, verdict, points, feedback, }: {
+    question: Question;
+    verdict: Verdict;
+    points?: QuestionPoints;
+    feedback?: string;
+}): import("react").JSX.Element;

package/dist/lib/components/ui/widgets/education/questions/question-options.d.ts

@@ -1,5 +1,5 @@
 import { Question, QuestionOption, QuestionProps } from './types.js';
-type QuestionOptionsProps = Pick<QuestionProps, 'revealed' | 'disabled' | 'density' | 'showShortcuts'> & {
+type QuestionOptionsProps = Pick<QuestionProps, 'revealed' | 'verdict' | 'disabled' | 'density' | 'showShortcuts'> & {
     question: Question;
     options: QuestionOption[];
     value: string[];
@@ -7,5 +7,5 @@ type QuestionOptionsProps = Pick<QuestionProps, 'revealed' | 'disabled' | 'densi
     labelledBy?: string;
     onToggle: (id: string) => void;
 };
-export declare function QuestionOptions({ question, options, value, multiple, revealed, disabled, density, showShortcuts, labelledBy, onToggle, }: QuestionOptionsProps): import("react").JSX.Element;
+export declare function QuestionOptions({ question, options, value, multiple, revealed, verdict, disabled, density, showShortcuts, labelledBy, onToggle, }: QuestionOptionsProps): import("react").JSX.Element;
 export {};

package/dist/lib/components/ui/widgets/education/questions/question-text.d.ts

@@ -1,3 +1,3 @@
 import { QuestionProps } from './types.js';
 /** A typed answer: `text`, or `number` (a decimal keypad, an optional unit). */
-export declare function QuestionText({ question, value, onValueChange, revealed, disabled, showFeedback, }: QuestionProps): import("react").JSX.Element;
+export declare function QuestionText({ question, value, onValueChange, revealed, verdict, disabled, showFeedback, }: QuestionProps): import("react").JSX.Element;

package/dist/lib/components/ui/widgets/education/questions/question.d.ts

@@ -1,2 +1,2 @@
 import { QuestionProps } from './types.js';
-export declare function QuestionCard({ question, value, onValueChange, revealed, disabled, className, variant, density, showShortcuts, number, showFeedback, }: QuestionProps): import("react").JSX.Element;
+export declare function QuestionCard({ question, value, onValueChange, revealed: revealedProp, verdict, points, feedback, disabled, className, variant, density, showShortcuts, number, showFeedback, }: QuestionProps): import("react").JSX.Element;

package/dist/lib/components/ui/widgets/education/questions/types.d.ts

@@ -4,6 +4,27 @@ export type QuestionImage = {
     src: string;
     alt?: string;
 };
+/** What kind of file a question's `media` is. */
+export type QuestionMediaKind = 'image' | 'audio' | 'document';
+/**
+ * A file shown with the prompt: a picture (the default), an audio clip
+ * (`AudioPlayer`) or a document link (`FilePreview`). The kind comes from
+ * `kind`, else from the MIME `type`, else it is an image.
+ */
+export type QuestionMedia = QuestionImage & {
+    kind?: QuestionMediaKind;
+    /** MIME type (`audio/mpeg`, `application/pdf`): picks the kind and the player. */
+    type?: string;
+    /** The audio's title or the document's file name, its text alternative; `alt` is the fallback. */
+    name?: string;
+};
+/** The server's verdict on an answer: shown as given, never recomputed. */
+export type QuestionVerdict = 'correct' | 'incorrect' | 'pending';
+/** Points earned out of the points the question is worth. */
+export type QuestionPoints = {
+    awarded: number;
+    possible: number;
+};
 export type QuestionOption = {
     id: string;
     label: ReactNode;
@@ -25,7 +46,7 @@ export type Question = {
     placeholder?: string;
     exact?: boolean;
     /** A picture shown with the prompt; give it an `alt` unless decorative. */
-    media?: QuestionImage;
+    media?: QuestionMedia;
     /** Shown on demand, behind a "Show hint" button. */
     hint?: string;
     /** `number`: how far off an answer may be and still count (default 0). */
@@ -38,6 +59,17 @@ export type QuestionProps = {
     value?: QuestionAnswer;
     onValueChange?: (value: QuestionAnswer) => void;
     revealed?: boolean;
+    /**
+     * The verdict the server gave, shown as given (no comparison with
+     * `question.correct` in the browser). It reveals the card; `pending` is a
+     * free answer still waiting for a grader. `question.correct` may still
+     * be passed to highlight the correct choices.
+     */
+    verdict?: QuestionVerdict;
+    /** Points earned, shown in the verdict banner (needs `verdict`). */
+    points?: QuestionPoints;
+    /** A grader's remark, shown in the verdict banner (needs `verdict`). */
+    feedback?: string;
     disabled?: boolean;
     className?: string;
     /** `card` (the default) is framed; `plain` sits inside another surface. */

package/dist/lib/hooks/index.d.ts

@@ -1,5 +1,6 @@
 export * from './resolve-theme.js';
 export * from './use-allowed-transitions.js';
+export * from './use-countdown.js';
 export { useCspNonce } from './use-csp-nonce.js';
 export * from './use-focus-on-mount.js';
 export * from './use-formatters.js';

package/dist/lib/hooks/use-countdown.d.ts

@@ -0,0 +1,18 @@
+export type UseCountdownOptions = {
+    /** Holds the clock where it is; it carries on from there when it turns false. */
+    paused?: boolean;
+    /** Runs once, when the clock reaches zero. */
+    onExpire?: () => void;
+    /**
+     * Starts the clock over from `duration` whenever it changes, even for the
+     * same duration: a second refusal that answers "retry in 30 s" again.
+     */
+    key?: string | number;
+};
+/**
+ * Seconds left of `duration`, ticking on the client only (the server and the
+ * first render show the full time). Pausing keeps what is left; a new
+ * `duration`, or a new `key`, starts over. `onExpire` runs once, when it
+ * reaches zero.
+ */
+export declare function useCountdown(duration: number, { paused, onExpire, key }?: UseCountdownOptions): number;

package/dist/lib/i18n/resources/en/en.d.ts

@@ -333,6 +333,10 @@ export declare const en: {
             correct: string;
             incorrect: string;
             unanswered: string;
+            pending: string;
+            "points-of": string;
+            audio: string;
+            document: string;
             "correct-answer": string;
             "your-answer": string;
             streak: string;
@@ -352,6 +356,14 @@ export declare const en: {
             "retry-wrong": string;
             retrying: string;
         };
+        "question-navigator": {
+            label: string;
+            item: string;
+            answered: string;
+            unanswered: string;
+            flagged: string;
+            current: string;
+        };
         "step-dots": {
             label: string;
             step: string;
@@ -365,6 +377,7 @@ export declare const en: {
             label: string;
             left: string;
             expired: string;
+            warning: string;
         };
         "option-tile": {
             correct: string;
@@ -1380,9 +1393,28 @@ export declare const en: {
             busy: string;
             active: string;
         };
+        "vote-tally": {
+            votes: string;
+            share: string;
+            leader: string;
+            tie: string;
+            selected: string;
+            empty: string;
+            more: string;
+            "voters-of": string;
+            abstained: string;
+            cast: string;
+            leads: string;
+            "tied-between": string;
+        };
         "seat-ring": {
             empty: string;
         };
+        "secret-card": {
+            reveal: string;
+            revealed: string;
+            hidden: string;
+        };
         "country-field": {
             placeholder: string;
         };

package/dist/lib/i18n/resources/en/material.json.d.ts

@@ -323,6 +323,10 @@ declare const _default: {
 		"correct": "Correct!",
 		"incorrect": "Not quite",
 		"unanswered": "Not answered",
+		"pending": "Awaiting grading",
+		"points-of": "{awarded} / {possible} points",
+		"audio": "Audio for this question",
+		"document": "Document for this question",
 		"correct-answer": "Correct answer: {answer}",
 		"your-answer": "Your answer: {answer}",
 		"streak": "{count} in a row",
@@ -342,6 +346,14 @@ declare const _default: {
 		"retry-wrong": "{count, plural, one {Retry # question} other {Retry # questions}}",
 		"retrying": "Retry round: {count, plural, one {# question} other {# questions}}"
 	},
+	"question-navigator": {
+		"label": "Questions",
+		"item": "Question {number}",
+		"answered": "answered",
+		"unanswered": "not answered",
+		"flagged": "flagged",
+		"current": "current"
+	},
 	"step-dots": {
 		"label": "Progress",
 		"step": "Step {current} of {total}",
@@ -354,7 +366,8 @@ declare const _default: {
 	"countdown-timer": {
 		"label": "Time remaining",
 		"left": "{time} left",
-		"expired": "Time is up"
+		"expired": "Time is up",
+		"warning": "Little time left"
 	},
 	"option-tile": {
 		"correct": "correct answer",
@@ -1370,9 +1383,28 @@ declare const _default: {
 		"busy": "Busy",
 		"active": "Active"
 	},
+	"vote-tally": {
+		"votes": "{count, plural, one {# vote} other {# votes}}",
+		"share": "{percent}%",
+		"leader": "Leader",
+		"tie": "Tie",
+		"selected": "Your vote",
+		"empty": "No votes yet",
+		"more": "+{count} more",
+		"voters-of": "Voters for {label}",
+		"abstained": "{count, plural, one {# abstention} other {# abstentions}}",
+		"cast": "{count, plural, one {# vote cast} other {# votes cast}}",
+		"leads": "{names} leads with {votes}",
+		"tied-between": "Tie between {names}, {votes} each"
+	},
 	"seat-ring": {
 		"empty": "Empty seat"
 	},
+	"secret-card": {
+		"reveal": "Show secret",
+		"revealed": "Secret revealed",
+		"hidden": "Secret hidden"
+	},
 	"country-field": {
 		"placeholder": "Country"
 	},

package/dist/lib/i18n/resources/fr/fr.d.ts

@@ -333,6 +333,10 @@ export declare const fr: {
             correct: string;
             incorrect: string;
             unanswered: string;
+            pending: string;
+            "points-of": string;
+            audio: string;
+            document: string;
             "correct-answer": string;
             "your-answer": string;
             streak: string;
@@ -352,6 +356,14 @@ export declare const fr: {
             "retry-wrong": string;
             retrying: string;
         };
+        "question-navigator": {
+            label: string;
+            item: string;
+            answered: string;
+            unanswered: string;
+            flagged: string;
+            current: string;
+        };
         "step-dots": {
             label: string;
             step: string;
@@ -365,6 +377,7 @@ export declare const fr: {
             label: string;
             left: string;
             expired: string;
+            warning: string;
         };
         "option-tile": {
             correct: string;
@@ -1380,9 +1393,28 @@ export declare const fr: {
             busy: string;
             active: string;
         };
+        "vote-tally": {
+            votes: string;
+            share: string;
+            leader: string;
+            tie: string;
+            selected: string;
+            empty: string;
+            more: string;
+            "voters-of": string;
+            abstained: string;
+            cast: string;
+            leads: string;
+            "tied-between": string;
+        };
         "seat-ring": {
             empty: string;
         };
+        "secret-card": {
+            reveal: string;
+            revealed: string;
+            hidden: string;
+        };
         "country-field": {
             placeholder: string;
         };

package/dist/lib/i18n/resources/fr/material.json.d.ts

@@ -323,6 +323,10 @@ declare const _default: {
 		"correct": "Bonne réponse !",
 		"incorrect": "Pas tout à fait",
 		"unanswered": "Sans réponse",
+		"pending": "En attente de correction",
+		"points-of": "{awarded} / {possible} points",
+		"audio": "Audio de cette question",
+		"document": "Document de cette question",
 		"correct-answer": "Bonne réponse : {answer}",
 		"your-answer": "Votre réponse : {answer}",
 		"streak": "{count} d’affilée",
@@ -342,6 +346,14 @@ declare const _default: {
 		"retry-wrong": "{count, plural, one {Refaire # question} other {Refaire # questions}}",
 		"retrying": "Nouvel essai : {count, plural, one {# question} other {# questions}}"
 	},
+	"question-navigator": {
+		"label": "Questions",
+		"item": "Question {number}",
+		"answered": "répondue",
+		"unanswered": "sans réponse",
+		"flagged": "marquée",
+		"current": "en cours"
+	},
 	"step-dots": {
 		"label": "Progression",
 		"step": "Étape {current} sur {total}",
@@ -354,7 +366,8 @@ declare const _default: {
 	"countdown-timer": {
 		"label": "Temps restant",
 		"left": "Plus que {time}",
-		"expired": "Temps écoulé"
+		"expired": "Temps écoulé",
+		"warning": "Il reste peu de temps"
 	},
 	"option-tile": {
 		"correct": "bonne réponse",
@@ -1370,9 +1383,28 @@ declare const _default: {
 		"busy": "Occupé",
 		"active": "Actif"
 	},
+	"vote-tally": {
+		"votes": "{count, plural, one {# vote} other {# votes}}",
+		"share": "{percent} %",
+		"leader": "En tête",
+		"tie": "Égalité",
+		"selected": "Votre vote",
+		"empty": "Aucun vote pour l'instant",
+		"more": "+{count} de plus",
+		"voters-of": "Votants pour {label}",
+		"abstained": "{count, plural, one {# abstention} other {# abstentions}}",
+		"cast": "{count, plural, one {# vote exprimé} other {# votes exprimés}}",
+		"leads": "{names} est en tête avec {votes}",
+		"tied-between": "Égalité entre {names}, {votes} chacun"
+	},
 	"seat-ring": {
 		"empty": "Place libre"
 	},
+	"secret-card": {
+		"reveal": "Afficher le secret",
+		"revealed": "Secret révélé",
+		"hidden": "Secret masqué"
+	},
 	"country-field": {
 		"placeholder": "Pays"
 	},

package/dist/lib/i18n/resources/resources.d.ts

@@ -331,6 +331,10 @@ export declare const resources: {
                 correct: string;
                 incorrect: string;
                 unanswered: string;
+                pending: string;
+                "points-of": string;
+                audio: string;
+                document: string;
                 "correct-answer": string;
                 "your-answer": string;
                 streak: string;
@@ -350,6 +354,14 @@ export declare const resources: {
                 "retry-wrong": string;
                 retrying: string;
             };
+            "question-navigator": {
+                label: string;
+                item: string;
+                answered: string;
+                unanswered: string;
+                flagged: string;
+                current: string;
+            };
             "step-dots": {
                 label: string;
                 step: string;
@@ -363,6 +375,7 @@ export declare const resources: {
                 label: string;
                 left: string;
                 expired: string;
+                warning: string;
             };
             "option-tile": {
                 correct: string;
@@ -1378,9 +1391,28 @@ export declare const resources: {
                 busy: string;
                 active: string;
             };
+            "vote-tally": {
+                votes: string;
+                share: string;
+                leader: string;
+                tie: string;
+                selected: string;
+                empty: string;
+                more: string;
+                "voters-of": string;
+                abstained: string;
+                cast: string;
+                leads: string;
+                "tied-between": string;
+            };
             "seat-ring": {
                 empty: string;
             };
+            "secret-card": {
+                reveal: string;
+                revealed: string;
+                hidden: string;
+            };
             "country-field": {
                 placeholder: string;
             };
@@ -3242,6 +3274,10 @@ export declare const resources: {
                 correct: string;
                 incorrect: string;
                 unanswered: string;
+                pending: string;
+                "points-of": string;
+                audio: string;
+                document: string;
                 "correct-answer": string;
                 "your-answer": string;
                 streak: string;
@@ -3261,6 +3297,14 @@ export declare const resources: {
                 "retry-wrong": string;
                 retrying: string;
             };
+            "question-navigator": {
+                label: string;
+                item: string;
+                answered: string;
+                unanswered: string;
+                flagged: string;
+                current: string;
+            };
             "step-dots": {
                 label: string;
                 step: string;
@@ -3274,6 +3318,7 @@ export declare const resources: {
                 label: string;
                 left: string;
                 expired: string;
+                warning: string;
             };
             "option-tile": {
                 correct: string;
@@ -4289,9 +4334,28 @@ export declare const resources: {
                 busy: string;
                 active: string;
             };
+            "vote-tally": {
+                votes: string;
+                share: string;
+                leader: string;
+                tie: string;
+                selected: string;
+                empty: string;
+                more: string;
+                "voters-of": string;
+                abstained: string;
+                cast: string;
+                leads: string;
+                "tied-between": string;
+            };
             "seat-ring": {
                 empty: string;
             };
+            "secret-card": {
+                reveal: string;
+                revealed: string;
+                hidden: string;
+            };
             "country-field": {
                 placeholder: string;
             };