stackblitz · GitHub

TutorialKit exposes low level APIs that authors can utilize to provide highly custom experience in their tutorials. These APIs allow authors to control internal parts of TutorialKit. See https://tutorialkit.dev/reference/tutorialkit-api for the API documentation and https://tutorialkit.dev/guides/how-to-use-tutorialkit-api/ for example custom React components using these APIs.

Here are few examples of the API usage:

Example Link
Write to terminal Open in StackBlitz
Access tutorial state Open in StackBlitz
Provide feedback to user when lesson is solved Open in StackBlitz

At the moment the API of tutorialkit:store is experimental, meaning that its API may introduce breaking changes in minor and patch releases. These changes can only affect your application if you are directly using tutorialkit:store module. Using TutorialKit through Astro is not affected.

The API surface of tutorialkit:store is wide and exposes many low level internal parts that it probably shouldn't. If you are using any of these APIs, you can help us stabilizing the API by sharing your use case here in this discussion. We are also happy to hear if the API is missing something that you would like it to have.

Read the original on github.com ↗