Edu SDKEdu SDK
React

StudyGuide

Render a study guide generated by createStudyGuide.

Renders a study guide from createStudyGuide().

Usage

import { StudyGuide } from "@edu-sdk/react";
import "@edu-sdk/react/styles.css";

<StudyGuide studyGuide={studyGuide} />

Props

type StudyGuideProps = {
  studyGuide: StudyGuide;
  className?: string;
  classNames?: StudyGuideClassNames;
};

classNames

KeyPart
rootRoot article
titleTitle
summarySummary text
sectionSection wrapper
sectionTitleSection heading
keyConceptsKey concepts list
keyConceptOne concept card
conceptNameConcept name
conceptExplanationConcept explanation
reviewQuestionsReview questions list
reviewQuestionOne review question

Example

<StudyGuide
  studyGuide={studyGuide}
  className="my-guide"
  classNames={{
    title: "my-title",
    keyConcept: "my-concept"
  }}
/>

See Styling for styles.css and CSS variables.

On this page