@lessonkit/react 1.3.1 → 1.5.0

package/dist/blocks-entry.d.cts

@@ -0,0 +1,471 @@
+import * as _lessonkit_core from '@lessonkit/core';
+import { AssessmentHandle, AssessmentBaseProps, AssessmentBehaviour, BlockId, CompoundHandle } from '@lessonkit/core';
+import * as React$1 from 'react';
+import React__default from 'react';
+
+type TrueFalseProps = AssessmentBaseProps & {
+    question: string;
+    answer: boolean;
+};
+declare const TrueFalse: React__default.ForwardRefExoticComponent<_lessonkit_core.AssessmentBehaviour & {
+    checkId: _lessonkit_core.CheckId;
+    passingScore?: number;
+} & {
+    question: string;
+    answer: boolean;
+} & React__default.RefAttributes<AssessmentHandle>>;
+
+type MarkTheWordsProps = AssessmentBaseProps & {
+    /** Plain text; words listed in `correctWords` are selectable targets. */
+    text: string;
+    correctWords: string[];
+};
+declare const MarkTheWords: React__default.ForwardRefExoticComponent<_lessonkit_core.AssessmentBehaviour & {
+    checkId: _lessonkit_core.CheckId;
+    passingScore?: number;
+} & {
+    /** Plain text; words listed in `correctWords` are selectable targets. */
+    text: string;
+    correctWords: string[];
+} & React__default.RefAttributes<AssessmentHandle>>;
+
+type FillInBlankSpec = {
+    id: string;
+    answer: string;
+};
+type FillInTheBlanksProps = AssessmentBaseProps & {
+    /** Text with `*` wrapping each blank answer, e.g. "The *capital* of France is *Paris*." */
+    template: string;
+    /** Optional explicit blanks (overrides parsing from template). */
+    blanks?: FillInBlankSpec[];
+};
+declare const FillInTheBlanks: React__default.ForwardRefExoticComponent<_lessonkit_core.AssessmentBehaviour & {
+    checkId: _lessonkit_core.CheckId;
+    passingScore?: number;
+} & {
+    /** Text with `*` wrapping each blank answer, e.g. "The *capital* of France is *Paris*." */
+    template: string;
+    /** Optional explicit blanks (overrides parsing from template). */
+    blanks?: FillInBlankSpec[];
+} & React__default.RefAttributes<AssessmentHandle>>;
+
+type DragTheWordsProps = AssessmentBaseProps & {
+    /** Sentence with `*` around drop zones; `words` are draggable options. */
+    template: string;
+    words: string[];
+};
+declare const DragTheWords: React__default.ForwardRefExoticComponent<_lessonkit_core.AssessmentBehaviour & {
+    checkId: _lessonkit_core.CheckId;
+    passingScore?: number;
+} & {
+    /** Sentence with `*` around drop zones; `words` are draggable options. */
+    template: string;
+    words: string[];
+} & React__default.RefAttributes<AssessmentHandle>>;
+
+type DragItem = {
+    id: string;
+    label: string;
+};
+type DropTarget = {
+    id: string;
+    label: string;
+    accepts: string;
+};
+type DragAndDropProps = AssessmentBaseProps & {
+    items: DragItem[];
+    targets: DropTarget[];
+};
+declare const DragAndDrop: React__default.ForwardRefExoticComponent<_lessonkit_core.AssessmentBehaviour & {
+    checkId: _lessonkit_core.CheckId;
+    passingScore?: number;
+} & {
+    items: DragItem[];
+    targets: DropTarget[];
+} & React__default.RefAttributes<AssessmentHandle>>;
+
+type AssessmentSequenceProps = AssessmentBehaviour & {
+    children: React__default.ReactNode;
+    /** Show one child assessment at a time (Question Set). */
+    sequential?: boolean;
+    /** When sequential, require an answer on the active step before Next. Default true. */
+    requireAnswerBeforeNext?: boolean;
+    blockId?: BlockId;
+};
+declare const AssessmentSequence: React__default.ForwardRefExoticComponent<AssessmentBehaviour & {
+    children: React__default.ReactNode;
+    /** Show one child assessment at a time (Question Set). */
+    sequential?: boolean;
+    /** When sequential, require an answer on the active step before Next. Default true. */
+    requireAnswerBeforeNext?: boolean;
+    blockId?: BlockId;
+} & React__default.RefAttributes<CompoundHandle>>;
+
+type TextProps = {
+    blockId?: BlockId;
+    children: React__default.ReactNode;
+};
+declare function Text(props: TextProps): React__default.JSX.Element;
+
+type HeadingProps = {
+    blockId?: BlockId;
+    level: 1 | 2 | 3;
+    children: React.ReactNode;
+};
+declare function Heading(props: HeadingProps): React$1.JSX.Element;
+
+type ImageProps = {
+    blockId?: BlockId;
+    src: string;
+    alt: string;
+};
+declare function Image(props: ImageProps): React$1.JSX.Element;
+
+type VideoProps = {
+    blockId: BlockId;
+    src: string;
+    poster?: string;
+    /** WebVTT captions track URL. */
+    captions?: string;
+    title?: string;
+};
+declare function Video(props: VideoProps): React__default.JSX.Element;
+
+type PageProps = {
+    blockId: BlockId;
+    title?: string;
+    /** When true, page is used as a book chapter but hidden until navigated (InteractiveBook). */
+    hidden?: boolean;
+    /** Index within a compound parent (set by InteractiveBook). */
+    pageIndex?: number;
+    /** Compound parent type for telemetry (e.g. InteractiveBook). */
+    parentType?: string;
+    children: React__default.ReactNode;
+};
+declare function Page(props: PageProps): React__default.JSX.Element;
+
+type InteractiveBookProps = {
+    blockId: BlockId;
+    title: string;
+    showBookScore?: boolean;
+    children: React__default.ReactElement<PageProps> | React__default.ReactElement<PageProps>[];
+};
+declare const InteractiveBook: React__default.ForwardRefExoticComponent<InteractiveBookProps & React__default.RefAttributes<CompoundHandle>>;
+
+type SlideProps = {
+    blockId: BlockId;
+    title?: string;
+    /** When true, slide is used in a deck but hidden until navigated (SlideDeck). */
+    hidden?: boolean;
+    /** Index within a compound parent (set by SlideDeck). */
+    slideIndex?: number;
+    /** Compound parent type for telemetry (e.g. SlideDeck). */
+    parentType?: string;
+    children: React__default.ReactNode;
+};
+declare function Slide(props: SlideProps): React__default.JSX.Element;
+
+type SlideDeckProps = {
+    blockId: BlockId;
+    title: string;
+    showDeckScore?: boolean;
+    children: React__default.ReactElement<SlideProps> | React__default.ReactElement<SlideProps>[];
+};
+declare const SlideDeck: React__default.ForwardRefExoticComponent<SlideDeckProps & React__default.RefAttributes<CompoundHandle>>;
+
+type TimedCueProps = {
+    atSeconds: number;
+    label?: string;
+    mustComplete?: boolean;
+    /** Set by InteractiveVideo when cue is not active. */
+    hidden?: boolean;
+    cueIndex?: number;
+    parentType?: string;
+    children: React__default.ReactElement;
+};
+declare function TimedCue(props: TimedCueProps): React__default.JSX.Element;
+
+type InteractiveVideoProps = {
+    blockId: BlockId;
+    title: string;
+    src: string;
+    poster?: string;
+    captions?: string;
+    showVideoScore?: boolean;
+    children: React__default.ReactElement<TimedCueProps> | React__default.ReactElement<TimedCueProps>[];
+};
+declare const InteractiveVideo: React__default.ForwardRefExoticComponent<InteractiveVideoProps & React__default.RefAttributes<CompoundHandle>>;
+
+type SummaryProps = AssessmentBaseProps & {
+    statements: string[];
+    /** Ordered correct summary statements. */
+    correct: string[];
+};
+declare const Summary: React__default.ForwardRefExoticComponent<_lessonkit_core.AssessmentBehaviour & {
+    checkId: _lessonkit_core.CheckId;
+    passingScore?: number;
+} & {
+    statements: string[];
+    /** Ordered correct summary statements. */
+    correct: string[];
+} & React__default.RefAttributes<AssessmentHandle>>;
+
+type ImagePair = {
+    id: string;
+    label: string;
+    imageSrc: string;
+};
+type ImagePairingProps = AssessmentBaseProps & {
+    pairs: ImagePair[];
+};
+declare const ImagePairing: React__default.ForwardRefExoticComponent<_lessonkit_core.AssessmentBehaviour & {
+    checkId: _lessonkit_core.CheckId;
+    passingScore?: number;
+} & {
+    pairs: ImagePair[];
+} & React__default.RefAttributes<AssessmentHandle>>;
+
+type SequencingImage = {
+    id: string;
+    src: string;
+    alt: string;
+};
+type ImageSequencingProps = AssessmentBaseProps & {
+    images: SequencingImage[];
+    correctOrder: string[];
+};
+declare const ImageSequencing: React__default.ForwardRefExoticComponent<_lessonkit_core.AssessmentBehaviour & {
+    checkId: _lessonkit_core.CheckId;
+    passingScore?: number;
+} & {
+    images: SequencingImage[];
+    correctOrder: string[];
+} & React__default.RefAttributes<AssessmentHandle>>;
+
+type ArithmeticProblem = {
+    question: string;
+    answer: string;
+};
+type ArithmeticQuizProps = AssessmentBaseProps & {
+    problems: ArithmeticProblem[];
+    timeLimitSeconds?: number;
+};
+declare const ArithmeticQuiz: React__default.ForwardRefExoticComponent<_lessonkit_core.AssessmentBehaviour & {
+    checkId: _lessonkit_core.CheckId;
+    passingScore?: number;
+} & {
+    problems: ArithmeticProblem[];
+    timeLimitSeconds?: number;
+} & React__default.RefAttributes<AssessmentHandle>>;
+
+type EssayProps = AssessmentBaseProps & {
+    question: string;
+    minLength?: number;
+};
+declare const Essay: React__default.ForwardRefExoticComponent<_lessonkit_core.AssessmentBehaviour & {
+    checkId: _lessonkit_core.CheckId;
+    passingScore?: number;
+} & {
+    question: string;
+    minLength?: number;
+} & React__default.RefAttributes<AssessmentHandle>>;
+
+type QuestionnaireField = {
+    id: string;
+    label: string;
+    type: "text" | "textarea";
+};
+type QuestionnaireProps = {
+    blockId: BlockId;
+    fields: QuestionnaireField[];
+};
+declare function Questionnaire(props: QuestionnaireProps): React__default.JSX.Element;
+
+type MemoryPair = {
+    id: string;
+    label: string;
+};
+type MemoryGameProps = {
+    blockId: BlockId;
+    pairs: MemoryPair[];
+    /** Optional self-score mode (not LMS-scored). */
+    selfScore?: boolean;
+};
+declare function MemoryGame(props: MemoryGameProps): React__default.JSX.Element;
+
+type InformationPanel = {
+    id: string;
+    title: string;
+    body: string;
+};
+type InformationWallProps = {
+    blockId: BlockId;
+    panels: InformationPanel[];
+};
+declare function InformationWall(props: InformationWallProps): React__default.JSX.Element;
+
+type ParallaxSlide = {
+    title: string;
+    body: string;
+    imageSrc?: string;
+};
+type ParallaxSlideshowProps = {
+    blockId: BlockId;
+    slides: ParallaxSlide[];
+};
+declare function ParallaxSlideshow(props: ParallaxSlideshowProps): React__default.JSX.Element | null;
+
+type AccordionSection = {
+    id: string;
+    title: string;
+    content: React__default.ReactNode;
+};
+type AccordionProps = {
+    blockId: BlockId;
+    sections: AccordionSection[];
+};
+declare function Accordion(props: AccordionProps): React__default.JSX.Element;
+
+type DialogCard = {
+    front: string;
+    back: string;
+};
+type DialogCardsProps = {
+    blockId: BlockId;
+    cards: DialogCard[];
+};
+declare function DialogCards(props: DialogCardsProps): React__default.JSX.Element | null;
+
+type Flashcard = {
+    front: string;
+    back: string;
+};
+type FlashcardsProps = {
+    blockId: BlockId;
+    cards: Flashcard[];
+    /** Optional self-score mode (not LMS-scored). */
+    selfScore?: boolean;
+};
+declare function Flashcards(props: FlashcardsProps): React__default.JSX.Element | null;
+
+type HotspotSpec = {
+    id: string;
+    label: string;
+    x: number;
+    y: number;
+    content: React__default.ReactNode;
+};
+type ImageHotspotsProps = {
+    blockId: BlockId;
+    src: string;
+    alt: string;
+    hotspots: HotspotSpec[];
+};
+declare function ImageHotspots(props: ImageHotspotsProps): React__default.JSX.Element;
+
+type ImageSlide = {
+    src: string;
+    alt: string;
+    caption?: string;
+};
+type ImageSliderProps = {
+    blockId: BlockId;
+    slides: ImageSlide[];
+};
+declare function ImageSlider(props: ImageSliderProps): React__default.JSX.Element | null;
+
+type HotspotTarget = {
+    id: string;
+    label: string;
+    x: number;
+    y: number;
+};
+type FindHotspotProps = AssessmentBaseProps & {
+    src: string;
+    alt: string;
+    targets: HotspotTarget[];
+    correctTargetId: string;
+};
+declare const FindHotspot: React__default.ForwardRefExoticComponent<_lessonkit_core.AssessmentBehaviour & {
+    checkId: _lessonkit_core.CheckId;
+    passingScore?: number;
+} & {
+    src: string;
+    alt: string;
+    targets: HotspotTarget[];
+    correctTargetId: string;
+} & React__default.RefAttributes<AssessmentHandle>>;
+
+type FindMultipleHotspotsProps = AssessmentBaseProps & {
+    src: string;
+    alt: string;
+    targets: HotspotTarget[];
+    correctTargetIds: string[];
+};
+declare const FindMultipleHotspots: React__default.ForwardRefExoticComponent<_lessonkit_core.AssessmentBehaviour & {
+    checkId: _lessonkit_core.CheckId;
+    passingScore?: number;
+} & {
+    src: string;
+    alt: string;
+    targets: HotspotTarget[];
+    correctTargetIds: string[];
+} & React__default.RefAttributes<AssessmentHandle>>;
+
+type BranchNodeProps = {
+    nodeId: string;
+    title?: string;
+    /** When true, node is treated as an end state (no outgoing choices expected). */
+    terminal?: boolean;
+    /** When true, node is hidden until navigated (set by BranchingScenario). */
+    hidden?: boolean;
+    /** Index within BranchingScenario (set by parent). */
+    nodeIndex?: number;
+    children: React__default.ReactNode;
+};
+declare function BranchNode(props: BranchNodeProps): React__default.JSX.Element;
+
+type BranchingScenarioProps = {
+    blockId: BlockId;
+    title: string;
+    startNodeId: string;
+    showPathScore?: boolean;
+    showPathRecap?: boolean;
+    enableSolutionsButton?: boolean;
+    children: React__default.ReactElement<BranchNodeProps> | React__default.ReactElement<BranchNodeProps>[];
+};
+declare const BranchingScenario: React__default.ForwardRefExoticComponent<BranchingScenarioProps & React__default.RefAttributes<CompoundHandle>>;
+
+type BranchChoiceProps = {
+    label: string;
+    targetNodeId: string;
+    scoreWeight?: number;
+    disabled?: boolean;
+    /** Source node id (set by BranchNode). */
+    fromNodeId?: string;
+};
+declare function BranchChoice(props: BranchChoiceProps): React__default.JSX.Element;
+
+type EmbedProps = {
+    blockId: BlockId;
+    src: string;
+    title: string;
+    /** Space-separated sandbox tokens beyond the default restrictive set. */
+    allow?: string;
+    aspectRatio?: string;
+};
+declare function Embed(props: EmbedProps): React__default.JSX.Element;
+
+type ChartDatum = {
+    label: string;
+    value: number;
+};
+type ChartProps = {
+    blockId: BlockId;
+    type: "bar" | "pie";
+    data: ChartDatum[];
+    title?: string;
+};
+declare function Chart(props: ChartProps): React__default.JSX.Element;
+
+export { Accordion, type AccordionProps, type AccordionSection, type ArithmeticProblem, ArithmeticQuiz, type ArithmeticQuizProps, AssessmentSequence, type AssessmentSequenceProps, BranchChoice, type BranchChoiceProps, BranchNode, type BranchNodeProps, BranchingScenario, type BranchingScenarioProps, Chart, type ChartDatum, type ChartProps, type DialogCard, DialogCards, type DialogCardsProps, DragAndDrop, type DragAndDropProps, type DragItem, DragTheWords, type DragTheWordsProps, type DropTarget, Embed, type EmbedProps, Essay, type EssayProps, type FillInBlankSpec, FillInTheBlanks, type FillInTheBlanksProps, FindHotspot, type FindHotspotProps, FindMultipleHotspots, type FindMultipleHotspotsProps, type Flashcard, Flashcards, type FlashcardsProps, Heading, type HeadingProps, type HotspotSpec, type HotspotTarget, Image, ImageHotspots, type ImageHotspotsProps, type ImagePair, ImagePairing, type ImagePairingProps, type ImageProps, ImageSequencing, type ImageSequencingProps, type ImageSlide, ImageSlider, type ImageSliderProps, type InformationPanel, InformationWall, type InformationWallProps, InteractiveBook, type InteractiveBookProps, InteractiveVideo, type InteractiveVideoProps, MarkTheWords, type MarkTheWordsProps, MemoryGame, type MemoryGameProps, type MemoryPair, Page, type PageProps, type ParallaxSlide, ParallaxSlideshow, type ParallaxSlideshowProps, Questionnaire, type QuestionnaireField, type QuestionnaireProps, type SequencingImage, Slide, SlideDeck, type SlideDeckProps, type SlideProps, Summary, type SummaryProps, Text, type TextProps, TimedCue, type TimedCueProps, TrueFalse, type TrueFalseProps, Video, type VideoProps };