Hiyve Components - v1.0.0
    Preparing search index...

    Module @hiyve/react-courses

    @hiyve/react-courses — React components for structured courses.

    For clients: MyCourses (their course library) and CoursePlayer (a sidebar outline with what is done and locked, the lesson, and Complete & continue). For providers: CourseLibrary, CourseBuilder (outline, blocks, unlock rules, quizzes) and CourseClients (enroll from your roster, approve lessons, follow progress). Wrap them in CourseProvider with a CourseStorage from @hiyve/courses — or, with Hiyve, useHiyveCourseStorage from @hiyve/react-courses/hiyve.

    import { CourseProvider, MyCourses, CoursePlayer } from '@hiyve/react-courses';

    <CourseProvider storage={storage} currentUser={{ userId: 'client@example.com', userName: 'Alex' }}>
    {enrollmentId
    ? <CoursePlayer enrollmentId={enrollmentId} onBack={() => setEnrollmentId(null)} />
    : <MyCourses onOpenCourse={setEnrollmentId} />}
    </CourseProvider>

    Interfaces

    BehindClient
    BlockViewProps
    ClientRow
    CourseBlockType
    CourseBuilderProps
    CourseClientsProps
    CourseColors
    CourseContextValue
    CourseEvents
    CourseLabels
    CourseLibraryProps
    CourseListItem
    CoursePlayerProps
    CourseProviderProps
    CourseUser
    CustomBlockEditorProps
    CustomBlockViewProps
    DashboardCourse
    LessonCommentsProps
    MyCourseItem
    MyCoursesProps
    PendingBlock
    ProviderDashboardProps
    ReviewAnswers
    ReviewDetails
    ReviewItem
    SubmissionViewerProps
    UseCourseBuilderResult
    UseCourseClientsResult
    UseCoursePlayerOptions
    UseCoursePlayerResult
    UseCoursesResult
    UseMyCoursesResult
    UseProviderDashboardResult

    Type Aliases

    AnyCourseBlockType
    ClientStatus
    NewBlockType
    SaveState

    Variables

    ACCESS_SYNC_INTERVAL_MS
    BUILDER_SAVE_IDLE_MS
    defaultCourseLabels
    PROGRESS_SAVE_IDLE_MS
    PROGRESS_SAVE_MAX_WAIT_MS

    Functions

    BlockView
    buildDefaultCourseColors
    CourseBuilder
    CourseClients
    CourseLibrary
    CoursePlayer
    CourseProvider
    LessonComments
    mergeCourseColors
    mergeCourseLabels
    MyCourses
    ProviderDashboard
    SubmissionViewer
    useAccessSync
    useCourseBuilder
    useCourseClients
    useCourseContext
    useCoursePlayer
    useCourses
    useMyCourses
    useProviderDashboard