@elemental/ui / Class

LmnVirtualViewportService

Decorators:@Injectable
Implements:OnDestroy

No documentation has been provided.

Methods

createViewport()

Create a virtual viewport

Presentation
createViewport(element: HTMLElement, id: string): void;
Parameters
NameTypeDescription
element
HTMLElement

@param element - The element to use as virtual viewport

id
string

@param id - The id of the virtual viewport

Returns
void

destroyViewport()

Destroy a virtual viewport

Presentation
destroyViewport(id: string): void;
Parameters
NameTypeDescription
id
string

@param id

Returns
void

nearestVirtualViewportSizeChanges()

Listen to size changes of the nearest virtual viewport of an element

Presentation
nearestVirtualViewportSizeChanges(element: HTMLElement): Observable<LmnSizeChange> | undefined;
Parameters
NameTypeDescription
element
HTMLElement

@param element - The element to listen to the size changes of the nearest virtual viewport of

Returns
Observable<LmnSizeChange> | undefined -
  • An observable that emits the size changes

retrieveNearestViewport()

Retrieve the nearest virtual viewport of an element, fallback to the window virtual viewport

Presentation
retrieveNearestViewport(element?: HTMLElement | undefined): LmnVirtualViewport | undefined;
Parameters
NameTypeDescription
element
HTMLElement | undefined

@param element - The element to retrieve the nearest virtual viewport of

Returns
LmnVirtualViewport | undefined -
  • The nearest virtual viewport

unregisterSizeChanges()

Unregister to the size changes of the nearest virtual viewport of an element

Presentation
unregisterSizeChanges(element: HTMLElement): void;
Parameters
NameTypeDescription
element
HTMLElement

@param element

Returns
void