Skip to content

feat!: mark @tutorialkit/react component API as experimental feature #346

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Sep 24, 2024
Merged

feat!: mark @tutorialkit/react component API as experimental feature #346

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions docs/tutorialkit.dev/src/content/docs/reference/react-components.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,13 @@ import sourceUseWebcontainer from "@components/react-examples/hooks/useWebcontai

You can reuse TutorialKit's React components in your own applications. They are designed to work well with the [WebContainer API][webcontainers].

:::note
Using `@tutorialkit/react` package directly without `@tutorialkit/astro` is **experimental** at the moment.
This package may introduce breaking changes in patch and minor version updates. Pay extra attention when updating the versions.

We are planning to stabilize component API of `@tutorialkit/react` in future.
:::

Comment on lines +25 to +31
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This renders to

Here's a simple editor that can be made with those components:

<ExampleSimpleEditor client:load />
Expand Down