How it works
The widget is built from three layers:State machine
Four validated states — from a collapsed button to an in-depth help flow.
Context engine
Tracks the active page, course, and progress to decide when to nudge.
React renderer
Renders each state, with per-state component overrides and theming.
Packages
The SDK ships three entry points:| Import path | What it provides |
|---|---|
@ulesson-education/mind-sdk | Core, framework-agnostic client, types, and errors |
@ulesson-education/mind-sdk/react | React provider, host component, and hooks |
@ulesson-education/mind-sdk/styles | The widget’s bundled stylesheet (style.css) |
Start here
Installation
Install the package and its peer dependencies.
Quickstart
Render the widget with a provider and host.
Configuration
Every option on
MindConfig.API reference
The full list of exports.
This guide is generated from the example app in
examples/react-playground, the best place to see the SDK end-to-end.