Adding a framework block¶
Checklist for contributors shipping a new @lessonkit/react block with H5P parity. Copy this table into your PR description.
Gate: a framework block is not done for H5P parity until every row is checked off.
# |
Task |
Where |
|---|---|---|
1 |
Set capability map Status to ✅ and confirm Framework column |
|
2 |
Add row: LessonKit id, H5P display name, H5P machine name (if known) |
Capability map + block catalog (v2 or v3 section) |
3 |
Document props, |
Block catalog per-block section + components guide table |
4 |
Add H5P equivalent admonition or table row on doc touchpoints |
Block catalog; H5P authors guide when status changes |
5 |
Storybook story titled with H5P name in subtitle (e.g. “FillInTheBlanks — H5P Fill in the Blanks”) |
|
6 |
If scored: example |
Golden example or packaging reference callout when first of kind |
7 |
|
|
Implementation order¶
Component —
packages/react/src/blocks/(orcomponents/for shell primitives); export frompackages/react/src/index.tsx.Catalog JSON — add entry to
block-catalog.v3.json; runnpm test -w @lessonkit/react(catalog parity tests).Telemetry — event names in
@lessonkit/core/telemetry-catalog.v3.jsonif new events; xAPI mapping in@lessonkit/xapi.Tests — unit tests in
packages/react/test/; Storybook story for visual states.Docs — complete the checklist table above.
Examples — add to a showcase example if the block is user-facing (framework-12-showcase for Tier C/D).
Internal naming reference¶
Maintainers only: H5P_CATALOG_CROSSWALK.md (not published in the public sidebar).