Class DomContainerProvider

DOM selector-based container provider.

Provides access to a DOM container element via a CSS selector. Implements IContainerProvider for use with position sources that don't have an intrinsic container (e.g., RAF-based sources, WebSocket sources).

Example

const containerProvider = new DomContainerProvider({
  selector: '#timeline-container',
});

containerProvider.onContainerReady(() => {
  const $container = containerProvider.getContainer();
  $container?.append('<div class="content">Ready!</div>');
});

await containerProvider.init();

Implements

IContainerProvider

Index

Constructors

constructor

Methods

destroy getContainer init onContainerReady

Constructors

constructor

new DomContainerProvider(
config: DomContainerProviderConfig,
): DomContainerProvider
Create a new DOM container provider.
Parameters
- config: DomContainerProviderConfig
  Configuration options
Returns DomContainerProvider
- Defined in timelineproviders/container-providers/dom-container-provider.ts:55

Methods

destroy

destroy(): void
Destroy the container provider and release resources.

Returns void
- Defined in timelineproviders/container-providers/dom-container-provider.ts:91

getContainer

getContainer(): JQuery<HTMLElement> | undefined
Get the container element.

Returns JQuery<HTMLElement> | undefined
jQuery-wrapped container element, or undefined if not initialized
Implementation of IContainerProvider.getContainer
- Defined in timelineproviders/container-providers/dom-container-provider.ts:107

init

init(): Promise<void>
Initialize the container provider.

Looks up the container element using the configured selector.

Returns Promise<void>
Throws
Error if the element is not found
- Defined in timelineproviders/container-providers/dom-container-provider.ts:70

onContainerReady

onContainerReady(callback: () => void): void
Register a callback for when the container is ready.

If the container is already ready, the callback is invoked immediately.
Parameters
- callback: () => void
  Function called when container is ready
Returns void
Implementation of IContainerProvider.onContainerReady
- Defined in timelineproviders/container-providers/dom-container-provider.ts:118

Class DomContainerProvider

Example

Implements

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns DomContainerProvider

Methods

destroy

Returns void

getContainer

Returns JQuery<HTMLElement> | undefined

init

Returns Promise<void>

Throws

onContainerReady

Parameters

Returns void

Settings

On This Page