Summary
Text annotation and highlighting component for educational content. Allows inline highlights with tooltips, margin notes, and collaborative annotations. Unique to the educational suite.
Motivation
Educational content needs inline annotations — highlight key terms, add instructor notes, show student highlights. This bridges the gap between static content and interactive learning.
Proposed API
{/* Inline highlight with tooltip */}
<Annotate type="definition" note="A function that calls itself">
recursive function
</Annotate>
{/* Margin note */}
<Annotate type="margin" note="This concept is crucial for the exam">
<p>Binary search divides the search space in half...</p>
</Annotate>
{/* Highlight with category */}
<Annotate type="highlight" color="yellow" category="key-concept">
O(log n) time complexity
</Annotate>
Requirements
Educational Use Cases
- Instructor annotations on reading material
- Key term highlighting with definitions
- Student note-taking on content
- Code annotation (highlight specific lines with explanations)
Technical Notes
- Renders as
<mark> with tooltip wrapper
- Integrates with existing Tooltip component
- MDX-compatible (usable via mdxComponents)
Summary
Text annotation and highlighting component for educational content. Allows inline highlights with tooltips, margin notes, and collaborative annotations. Unique to the educational suite.
Motivation
Educational content needs inline annotations — highlight key terms, add instructor notes, show student highlights. This bridges the gap between static content and interactive learning.
Proposed API
Requirements
Educational Use Cases
Technical Notes
<mark>with tooltip wrapper