@get-advantage/advantage / advantage/wrapper / AdvantageWrapper
Class: AdvantageWrapper
advantage/wrapper.AdvantageWrapper
Represents the AdvantageWrapper class, which extends the HTMLElement class and implements the IAdvantageWrapper interface. This class is responsible for creating and managing the wrapper element for Advantage ads.
Hierarchy
HTMLElement↳
AdvantageWrapper
Implements
Constructors
constructor
• new AdvantageWrapper(): AdvantageWrapper
Creates an instance of AdvantageWrapper.
Returns
Overrides
HTMLElement.constructor
Defined in
Properties
#activeFormatIframe
• Private #activeFormatIframe: null | HTMLIFrameElement = null
Defined in
#disconnectTimeout
• Private #disconnectTimeout: null | number = null
Defined in
#mutationObserver
• Private #mutationObserver: null | MutationObserver = null
Defined in
#root
• Private #root: ShadowRoot
Defined in
#slotAdvantageContent
• Private #slotAdvantageContent: HTMLSlotElement
Defined in
#slotChangeHandler
• Private #slotChangeHandler: null | () => void = null
Defined in
#slotChangeRegistered
• Private #slotChangeRegistered: boolean = false
Defined in
#styleSheet
• Private #styleSheet: CSSStyleSheet | HTMLStyleElement
Defined in
#trackedIframes
• Private #trackedIframes: WeakSet<HTMLIFrameElement>
Defined in
allowedFormats
• allowedFormats: null | string[] = null
Implementation of
IAdvantageWrapper.allowedFormats
Defined in
container
• container: HTMLDivElement
Implementation of
Defined in
content
• content: HTMLDivElement
Implementation of
Defined in
currentFormat
• currentFormat: string = ""
Implementation of
IAdvantageWrapper.currentFormat
Defined in
messageHandler
• messageHandler: AdvantageAdSlotResponder
Defined in
simulating
• simulating: boolean = false
Defined in
uiLayer
• uiLayer: IAdvantageUILayer
Implementation of
Defined in
DISCONNECT_TIMEOUT_MS
▪ Static Readonly DISCONNECT_TIMEOUT_MS: 100
Defined in
Accessors
contentNodes
• get contentNodes(): Node[]
Gets the content nodes assigned to the advantage-ad-slot.
Returns
Node[]
An array of content nodes.
Implementation of
IAdvantageWrapper.contentNodes
Defined in
Methods
#detectDOMChanges
▸ #detectDOMChanges(): void
Detects DOM changes and resets the wrapper if a new ad is loaded. Tracks iframes and resets the wrapper when an iframe that requested a format is removed.
Returns
void
Defined in
#updateCurrentFormatAttribute
▸ #updateCurrentFormatAttribute(): void
Updates the current-format attribute to match the currentFormat property. Sets the attribute when currentFormat has a value, removes it when empty.
Returns
void
Defined in
animateClose
▸ animateClose(callback?): void
Parameters
| Name | Type |
|---|---|
callback? | () => void |
Returns
void
Implementation of
IAdvantageWrapper.animateClose
Defined in
applyStylesToAllChildElements
▸ applyStylesToAllChildElements(styles): void
Applies styles to all child elements of the wrapper.
Parameters
| Name | Type | Description |
|---|---|---|
styles | string | The CSS styles to apply. |
Returns
void
Implementation of
IAdvantageWrapper.applyStylesToAllChildElements
Defined in
changeContent
▸ changeContent(content): void
Changes the content of the wrapper.
Parameters
| Name | Type | Description |
|---|---|---|
content | string | HTMLElement | The new content to be added to the wrapper. |
Returns
void
Implementation of
IAdvantageWrapper.changeContent
Defined in
clearAllowedFormats
▸ clearAllowedFormats(): void
Clears the programmatic whitelist so the wrapper falls back to attribute or default behaviour.
Returns
void
Implementation of
IAdvantageWrapper.clearAllowedFormats
Defined in
close
▸ close(): void
Closes the current ad format.
Returns
void
Implementation of
Defined in
connectedCallback
▸ connectedCallback(): void
Lifecycle method called when the element is connected to the DOM. Clears the disconnect timeout if the element reconnects quickly.
Returns
void
Defined in
disconnectedCallback
▸ disconnectedCallback(): void
Lifecycle method called when the element is disconnected from the DOM. Uses a timeout to distinguish between temporary removal and actual cleanup.
Returns
void
Defined in
forceFormat
▸ forceFormat(format, iframe?, options?): Promise<void>
Forces a specific ad format without waiting for a message from the iframe. This allows publishers to directly control which format to display.
Parameters
| Name | Type | Description |
|---|---|---|
format | string | The format to apply |
iframe? | HTMLIFrameElement | The iframe element to use for the ad (optional) |
options? | any | Additional options to pass to the format's setup function |
Returns
Promise<void>
A promise that resolves when the format has been applied
Implementation of
Defined in
insertCSS
▸ insertCSS(CSS): void
Inserts CSS into the shadow root of the wrapper.
Parameters
| Name | Type | Description |
|---|---|---|
CSS | string | The CSS to insert. |
Returns
void
Implementation of
Defined in
morphIntoFormat
▸ morphIntoFormat(format, message?): Promise<void>
Morphs the wrapper into a specific ad format. If allowed-formats is set (via attribute or API) it takes precedence over exclude-formats. Comparisons are case-insensitive.
Parameters
| Name | Type | Description |
|---|---|---|
format | string | The format to morph into. |
message? | AdvantageMessage | - |
Returns
Promise<void>
A promise that resolves when the morphing is complete.
Implementation of
IAdvantageWrapper.morphIntoFormat
Defined in
reset
▸ reset(): void
Resets the current ad format.
Returns
void
Implementation of
Defined in
resetCSS
▸ resetCSS(): void
Resets the CSS in the shadow root of the wrapper.
Returns
void
Implementation of
Defined in
setAllowedFormats
▸ setAllowedFormats(formats): void
Restrict this wrapper to the given list of formats. Calling this method overrides any list previously set via attribute or API.
Parameters
| Name | Type | Description |
|---|---|---|
formats | string[] | Array of format names that are allowed for this wrapper. |
Returns
void
Implementation of
IAdvantageWrapper.setAllowedFormats
Defined in
simulateFormat
▸ simulateFormat(format): Promise<void>
Simulates a specific ad format.
Parameters
| Name | Type | Description |
|---|---|---|
format | string | The format to simulate. |
Returns
Promise<void>
Implementation of
IAdvantageWrapper.simulateFormat