Component pages¶
Each page renders the real @lessonkit/react component in an embedded demo, explains when to use it, and shows copy-paste examples you can adapt into a course.
Coverage: 59 component pages — one for every block type in block-catalog.v3.json, including graph children (BranchNode, BranchChoice, MapStage, MapExit) and the KnowledgeCheck alias of Quiz. Multi-block guides: Course structure, Text & Heading.
Try it tabs: Live demo, React example, copy-paste AI prompt (for vibe coding), and Manifest / Packaging notes — synced from page-copy.json and manifest-snippets.json.
Related references
Need |
Page |
|---|---|
Full prop contracts and nesting rules |
|
Copy-paste snippets only (no live demo) |
|
Visual states in isolation |
|
Full courses |
Local preview
From the repo root: bash docs/scripts/build-component-demos.sh, then open docs/_static/component-demos/index.html#/true-false in a browser. Run npm -w lessonkit-docs-component-demos run dev for a fast edit loop.
Component picker¶
Component |
Category |
H5P-style name |
|---|---|---|
Content |
Accordion |
|
Content |
Advent Calendar |
|
Assessment |
Arithmetic Quiz |
|
Compound |
Question Set |
|
Content |
Audio Recorder |
|
Compound child |
Branching Scenario (choice) |
|
Compound |
Branching Scenario |
|
Compound child |
Branching Scenario (node) |
|
Content |
Chart |
|
Content |
Collage |
|
Assessment |
Combination Lock |
|
Container |
— |
|
Assessment |
Crossword |
|
Content |
Dialog Cards |
|
Assessment |
Drag and Drop |
|
Assessment |
Drag the Words |
|
Content |
Iframe Embedder |
|
Assessment |
Essay |
|
Assessment |
Fill in the Blanks |
|
Assessment |
Find the Hotspot |
|
Assessment |
Find Multiple Hotspots |
|
Content |
Flashcards |
|
Compound |
Game Map |
|
Assessment |
Guess the Answer |
|
Content |
Image |
|
Content |
Image Hotspots |
|
Content |
Image Juxtaposition |
|
Assessment |
Image Pairing |
|
Content |
Image Sequencing (frames) |
|
Assessment |
Image Sequencing |
|
Content |
Image Slider |
|
Content |
Information Wall |
|
Compound |
Interactive Book |
|
Compound |
Interactive Video |
|
Assessment |
Multiple Choice |
|
Compound child |
Game Map (exit) |
|
Compound child |
Game Map (stage) |
|
Assessment |
Mark the Words |
|
Content |
Memory Game |
|
Assessment |
Multimedia Choice |
|
Compound child |
Interactive Book (page) |
|
Content |
Parallax |
|
Content |
KewAr Code |
|
Content |
Questionnaire |
|
Assessment |
Multiple Choice |
|
Content |
— |
|
Content |
— |
|
Compound |
Single Choice Set |
|
Compound child |
Course Presentation (slide) |
|
Compound |
Course Presentation |
|
Assessment |
Sort the Paragraphs |
|
Assessment |
Summary |
|
Content |
Table |
|
Content |
— |
|
Compound child |
Interactive Video (cue) |
|
Content |
Timeline |
|
Assessment |
True/False |
|
Content |
Self-hosted video |
|
Assessment |
Find the words |
Adding a component page (contributors)¶
Add a focused demo to
docs/component-demos/src/registry.tsx(orsrc/demos/batch*.tsx) and an entry indocs/component-demos/manifest.jsonwithblockTypeset to the catalog id.Add copy to
docs/component-demos/page-copy.json, then runnode docs/scripts/scaffold-component-pages.mjs(or editdocs/reference/components/<slug>.mdby hand).Add packaging copy to
docs/component-demos/manifest-snippets.json— assessment JSON for scored blocks, note-only entries for compound containers (blockId, resume).Run
node docs/scripts/generate-component-ai-prompts.mjs(optional review) andnode docs/scripts/sync-component-try-it-tabs.mjsto refresh Try it tabs (Live demo | React | AI prompt | Manifest/Packaging).Run
node docs/scripts/generate-component-pages-index.mjs,node docs/scripts/sync-component-toctree.mjs,node docs/scripts/generate-block-props-doc.mjs, andnode docs/scripts/generate-h5p-component-page-index.mjs.Verify:
bash docs/scripts/build-component-demos.sh && bash docs/scripts/verify-component-demos.sh.
Demos may compose supporting blocks (for example TrueFalse inside SlideDeck) when that makes the primary component easier to understand.