Skip to content

feat: add doc for web components in MDX #12740

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

Closed
wants to merge 1 commit into from
Closed

feat: add doc for web components in MDX #12740

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
18 changes: 18 additions & 0 deletions src/content/docs/en/guides/integrations-guide/mdx.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -247,6 +247,24 @@ const { Content } = await render(entry);
<Content components={{ h1: CustomHeading }} />
```

### Using web components in MDX

If you have a web component defined in a separate JavaScript file, you can include it in your MDX file by importing the script and adding a `<script>` tag with `type="module"`.
The script will be executed on the client side.

```js title="src/web-component.js"
class MyEl extends HTMLElement { ... }
customElements.define('my-el', MyEl);
```

```mdx title="src/Page.mdx"
import webComponent from "./web-component.js?url";

<script src={webComponent} type="module"></script>

<my-el />
```

## Configuration

Once the MDX integration is installed, no configuration is necessary to use `.mdx` files in your Astro project.
Expand Down