TeachKit project

TeachKit / Design system

Documentation v0.1 · Released product

Design system contents

Components

Rich course and lesson content

Support formatted descriptions and instructions through the actual Trix editor and rendered-content styles.

On this page

Purpose and usage

Support formatted descriptions and instructions through the actual Trix editor and rendered-content styles.

Anatomy

Anatomy
PartContract
ToolbarSource Trix controls
Editable surfaceClient-loaded editor
Stored valueHTML representation
Rendered paneltrix-content typography

Variants and configuration

Variants and configuration
Input or variantBehavior
Client loadingDynamic import and mount behavior
Attachment controlFile-tools toolbar hidden globally
Content trustInput/render sanitation belongs to surrounding workflow

State coverage

State coverage
StateImplemented behavior
LoadingReal loading placeholder
EditingRich input surface
ViewingHTML displayed in content panel

Interaction and composition

  • Await editor hydration and actual content before capture.
  • Do not use screenshots of a loading editor as the finished applied example.
  • Keep heading, link and list formatting readable in learner views.
  • Hiding attachment controls is not authorization for file endpoints.

Accessibility and readiness

Keyboard toolbar use, selection, screen-reader announcements and HTML sanitation require manual validation. A hidden toolbar group does not disable every programmatic attachment path. The capture uses real course text with no server saves.

Source references

Source references
FileResponsibility
src/components/TrixEditor.tsxClient rich editor
src/components/TrixEditorWrapper.tsxWrapper
src/components/courses-public/logged-in/CourseInformationTabs.tsxRendered HTML context

Examples from the app

Actual TeachKit UI with Thomas McGee’s course content. Session, progress and connection specimens are simulated; no student data or live changes. Captured at 2× resolution or higher. Select an image to inspect it full size.

Lesson Editor · Component detail · Light · Desktop · 1920 × 742 px
Creator Instructions · Screen · Light · Desktop · 2880 × 2000 px
Creator Instructions · Screen · Light · Desktop · Full Page · 2880 × 6826 px

Source audit: 2026-10-07 · Revision d8cf23d0a329 · Documentation v0.1