@edpire/sdk 0.6.12 → 0.7.0

package/dist/react.d.mts

@@ -80,6 +80,28 @@ interface TakeBranding {
         showPoweredBy?: boolean;
     } | null;
 }
+/**
+ * Geometry of the question column. Branding covers colour and type; this covers
+ * the one thing branding could not reach.
+ */
+interface ShellLayout {
+    /**
+     * Max width of the question column. Any CSS length, or `"none"` to fill the
+     * container. Default `"48rem"` (768px).
+     *
+     * The default is a reading measure, not an arbitrary cap: at the runtime's
+     * base size it yields roughly 70–90 characters per line, already the top of
+     * the comfortable range. Past about `"60rem"` the eye starts losing its place
+     * on the return sweep, which costs a learner more on a long comprehension
+     * passage than the empty gutters ever did.
+     *
+     * Keep the default when the player owns the whole page (`h-dvh`, no host
+     * chrome) — that is what it was measured for. Set `"none"` when you mount the
+     * player inside your own layout and your container already supplies the
+     * measure, otherwise learners see a column inside a column.
+     */
+    maxWidth?: string;
+}
 type NodeDetail = {
     type: "choiceSet";
     correctChoiceIds: string[];
@@ -241,6 +263,16 @@ interface EdpireAssessmentPlayerProps {
     locale?: ShellLocale;
     /** Branding overrides. Org branding loads from Edpire automatically; pass this to override (white-labelling). */
     branding?: TakeBranding;
+    /**
+     * Geometry of the question column.
+     *
+     * `className` sizes the player's outer box; this sizes the question column
+     * inside it. They are different boxes: by default the questions sit in a
+     * centred 768px reading column whatever the outer box is. Keep that for a
+     * full-page player, pass `{ maxWidth: "none" }` when the player is embedded
+     * in a layout that already constrains width.
+     */
+    layout?: ShellLayout;
     /**
      * When set, the post-submit "View Full Report" button redirects here with
      * `?submission_id=...&score=...&max_score=...` appended. Omit to hide the button.
@@ -360,6 +392,12 @@ interface AssessmentShellProps {
     overlayConfig?: OverlayConfig;
     /** Scope grading/time-up overlays to this component instead of the viewport. */
     contained?: boolean;
+    /**
+     * Geometry of the question column. Omit for the default reading measure,
+     * which is what a full-page player wants. Pass `{ maxWidth: "none" }` when
+     * the shell is embedded inside a host layout that already constrains width.
+     */
+    layout?: ShellLayout;
     /** Media upload handler — required for file-upload and recording modes in
      *  OpenResponse questions. */
     mediaHandler?: QuestionRuntimeProps["mediaHandler"];
@@ -379,6 +417,6 @@ interface AssessmentShellProps {
      */
     fallbackLogoUrl?: string;
 }
-declare function AssessmentShell({ assessment, meta, locale, branding, timeLimitMinutes, startedAt, onSubmit, onViewReport, reportLabel, onBack, backLabel, allowReset, onReset, overlayConfig, contained, onClose, mediaHandler, onAddAnnex, fallbackLogoUrl, }: AssessmentShellProps): react_jsx_runtime.JSX.Element;
+declare function AssessmentShell({ assessment, meta, locale, branding, timeLimitMinutes, startedAt, onSubmit, onViewReport, reportLabel, onBack, backLabel, allowReset, onReset, overlayConfig, contained, layout, onClose, mediaHandler, onAddAnnex, fallbackLogoUrl, }: AssessmentShellProps): react_jsx_runtime.JSX.Element;
 
-export { AssessmentShell, type AssessmentShellProps, EdpireAssessmentPlayer, type EdpireAssessmentPlayerProps, EdpireQuestion, type EdpireQuestionProps, type ExerciseFeedbackData, type NodeDetail, type NodeFeedback, type OverlayConfig, type QuestionFeedback, type ShellLocale, type SpinnerTheme, type SubmitResult, type TakeBranding };
+export { AssessmentShell, type AssessmentShellProps, EdpireAssessmentPlayer, type EdpireAssessmentPlayerProps, EdpireQuestion, type EdpireQuestionProps, type ExerciseFeedbackData, type NodeDetail, type NodeFeedback, type OverlayConfig, type QuestionFeedback, type ShellLayout, type ShellLocale, type SpinnerTheme, type SubmitResult, type TakeBranding };