Skip to content

docs: Recommend JSComponent over ReactiveHTML #8622

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
philippjfr merged 1 commit into from
Jun 1, 2026
+6 −0
Merged

docs: Recommend JSComponent over ReactiveHTML #8622

Show file tree
Hide file tree
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
2 changes: 2 additions & 0 deletions doc/explanation/components/reactive_html_components.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@ This page will walk you through using the `ReactiveHTML` class to craft custom c

:::{admonition} warn
`ReactiveHTML` was the recommended approach for building custom components before so called ESM components were added. Refer to the [custom component how-to guides](../../how_to/custom_components/index) for more details.

We recommend using `JSComponent` over `ReactiveHTML` for new custom components.
:::

## Why Use `ReactiveHTML`?
Expand Down
4 changes: 4 additions & 0 deletions doc/how_to/custom_components/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -165,6 +165,10 @@ examples/esm_material_ui

Build custom components using HTML, CSS and Javascript and without Javascript build tools.

:::{admonition} warn
We recommend using `JSComponent` over `ReactiveHTML` for new custom components.
:::

::::{grid} 1 2 2 3
:gutter: 1 1 1 2

Expand Down
Loading