ENGLISH·COURSE API
    Preparing search index...

    Function

    ModuleOverview

    • The module overview as a route through its videos: a server-rendered header — back link, Lesson NN · Course eyebrow, title, and how many videos the module holds with their total runtime — above the learner's route.

      Parameters

      • __namedParameters: {
            course: {
                id: string & $brand<"CourseId">;
                slug: string & $brand<"Slug">;
                title: string;
                description: string;
                language: string;
                lessonCount: number;
                moduleCount: number;
                sequence: number;
                track: "level" | "reference";
                outcomes?: string[];
                audience?: string;
                highlights?: string[];
                sounds?: { vowels: string[]; consonants: string[] };
                translations?: Record<
                    string,
                    {
                        description?: string;
                        outcomes?: string[];
                        audience?: string;
                        highlights?: string[];
                    },
                >;
            };
            module: {
                id: string & $brand<"ModuleId">;
                courseId: string & $brand<"CourseId">;
                slug: string & $brand<"Slug">;
                title: string;
                sequence: number;
            };
            lessons: readonly (
                | {
                    kind: "reading";
                    id: string & $brand<"LessonId">;
                    courseId: string & $brand<"CourseId">;
                    moduleId: string & $brand<"ModuleId">;
                    sequence: number;
                    title: string;
                    body: string;
                }
                | {
                    kind: "video";
                    id: string & $brand<"LessonId">;
                    courseId: string & $brand<"CourseId">;
                    moduleId: string & $brand<"ModuleId">;
                    sequence: number;
                    title: string;
                    description: string;
                    source: string;
                    durationSeconds: number;
                    poster?: string;
                    uploadDate?: string;
                }
            )[];
            nextModule?: ModuleWithLessons;
        }

      Returns Element

      Everything here renders on the server except ModuleRoute. The route and its progress panel depend on progress stored in the browser, so they are the one client subtree; the header states only facts the server already knows.

      The header carries no decorative hero tile: a Module has no artwork, so a tile could only repeat the ordinal and a truncation of the title.

      Steps were once labelled "Episode N", a term that meant a Module on the course overview and a Lesson here. See the course-vocabulary capability.

    Settings

    Member Visibility