Skip to content

Commit

Permalink
Add initial content for getHTML (#33494)
Browse files Browse the repository at this point in the history
  • Loading branch information
lukewarlow authored May 9, 2024
1 parent 3966c40 commit 49fd748
Show file tree
Hide file tree
Showing 2 changed files with 99 additions and 0 deletions.
50 changes: 50 additions & 0 deletions files/en-us/web/api/element/gethtml/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
---
title: "Element: getHTML() method"
short-title: getHTML()
slug: Web/API/Element/getHTML
page-type: web-api-instance-method
browser-compat: api.Element.getHTML
---

{{APIRef("DOM")}}{{SeeCompatTable}}{{SecureContext_Header}}

The **`getHTML()`** method of the {{domxref("Element")}} interface is used to serialize an element's DOM to an HTML string.

## Syntax

```js-nolint
const html = element.getHTML(options)
```

### Parameters

- `options` {{optional_inline}}

- : An options object with the following optional parameters:

- `serializableShadowRoots`
- : A boolean value that specifies whether to include serializable shadow roots. The default value is `false`.
- `shadowRoots`
- : An array of {{domxref("ShadowRoot")}} objects to serialize. These are included regardless of whether they
are marked as serializable. The default value is an empty array.

### Return value

A string that represents the HTML serialization of the element.

### Exceptions

None.

## Specifications

{{Specifications}}

## Browser compatibility

{{Compat}}

## See Also

- {{domxref("ShadowRoot.getHTML()")}}
- {{domxref("Element.innerHTML")}}
49 changes: 49 additions & 0 deletions files/en-us/web/api/shadowroot/gethtml/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
---
title: "ShadowRoot: getHTML() method"
short-title: getHTML()
slug: Web/API/ShadowRoot/getHTML
page-type: web-api-instance-method
browser-compat: api.ShadowRoot.getHTML
---

{{APIRef("DOM")}}{{SeeCompatTable}}{{SecureContext_Header}}

The **`getHTML()`** method of the {{domxref("ShadowRoot")}} interface is used to serialize a shadow root's DOM to an HTML string.

## Syntax

```js-nolint
const html = shadowRoot.getHTML(options)
```

### Parameters

- `options` {{optional_inline}}

- : An options object with the following optional parameters:

- `serializableShadowRoots`
- : A boolean value that specifies whether to include serializable shadow roots. The default value is `false`.
- `shadowRoots`
- : An array of {{domxref("ShadowRoot")}} objects to serialize. These are included regardless of whether they
are marked as serializable. The default value is an empty array.

### Return value

A string that represents the HTML serialization of the shadow root.

### Exceptions

None.

## Specifications

{{Specifications}}

## Browser compatibility

{{Compat}}

## See Also

- {{domxref("ShadowRoot.innerHTML")}}

0 comments on commit 49fd748

Please sign in to comment.