API / wxt/utils/content-script-ui/iframe / IframeContentScriptUi

Interface: IframeContentScriptUi<TMounted>

Source: packages/wxt/src/utils/content-script-ui/iframe.ts:51

Contents

• Extends
• Type Parameters
  • TMounted
• Properties
  • autoMount
  • iframe
  • mount
  • mounted
  • remove
  • wrapper

Extends

• ContentScriptUi<TMounted>

Type Parameters

TMounted

TMounted

Properties

autoMount

autoMount: (options?) => void

Source: packages/wxt/src/utils/content-script-ui/types.ts:120

Call ui.autoMount() to automatically mount and remove the UI as the anchor is dynamically added/removed by the webpage.

Parameters

options?

AutoMountOptions

Returns

void

Inherited from

ContentScriptUi.autoMount

---

iframe

iframe: HTMLIFrameElement

Source: packages/wxt/src/utils/content-script-ui/iframe.ts:55

The iframe added to the DOM.

---

mount

mount: () => void

Source: packages/wxt/src/utils/content-script-ui/types.ts:109

Function that mounts or remounts the UI on the page.

Returns

void

Inherited from

ContentScriptUi.mount

---

mounted

mounted: TMounted | undefined

Source: packages/wxt/src/utils/content-script-ui/types.ts:4

Inherited from

ContentScriptUi.mounted

---

remove

remove: () => void

Source: packages/wxt/src/utils/content-script-ui/types.ts:112

Function that removes the UI from the webpage.

Returns

void

Inherited from

ContentScriptUi.remove

---

wrapper

wrapper: HTMLDivElement

Source: packages/wxt/src/utils/content-script-ui/iframe.ts:57

A wrapper div that assists in positioning.

---

Generated using typedoc-plugin-markdown and TypeDoc