@elemental/ui / Class

LmnSizeService

Decorators:@Injectable
Implements:OnDestroy

No documentation has been provided.

Properties

NameTypeDescription
windowScrollBarWidth
WritableSignal<number>

The width of the window scroll bar

Methods

#registerSizeWatcher()

No documentation has been provided.

Presentation
#registerSizeWatcher(element: HTMLElement | Window, id: string = WINDOW_SIZE_ELEMENT_ID): LmnSizeWatcher;
Parameters
NameTypeDescription
element
HTMLElement | Window
id
string
Returns
Overload #1

No documentation has been provided.

Presentation
#registerSizeWatcher(window: Window): LmnSizeWatcher;
Parameters
NameTypeDescription
window
Window
Returns
Overload #2

No documentation has been provided.

Presentation
#registerSizeWatcher(element: HTMLElement, id: string): LmnSizeWatcher;
Parameters
NameTypeDescription
element
HTMLElement
id
string
Returns

getSizeWatcher()

Get a size watcher

Presentation
getSizeWatcher(id: string): LmnSizeWatcher | undefined;
Parameters
NameTypeDescription
id
string

@param id - The id of the watcher

Returns
LmnSizeWatcher | undefined

hasSizeWatcher()

Check if a size watcher exists

Presentation
hasSizeWatcher(id: string): boolean;
Parameters
NameTypeDescription
id
string

@param id - The id of the watcher

Returns
boolean -
  • True if the watcher exists

listenToSizeChanges()

No documentation has been provided.

Presentation
listenToSizeChanges(id: string, options?: LmnSizeWatcherOptions | undefined): Observable<LmnSizeChange> | undefined;
Parameters
NameTypeDescription
id
string

@param id - The id of the watcher

options
LmnSizeWatcherOptions | undefined

@param options - The options of the watcher

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

registerSizeWatcher()

Register a size watcher for the element

Presentation
registerSizeWatcher(element: HTMLElement, id: string, options?: LmnSizeWatcherOptions | undefined): Observable<LmnSizeChange>;
Parameters
NameTypeDescription
element
HTMLElement

@param element - The element to watch

id
string

@param id - The id of the watcher

options
LmnSizeWatcherOptions | undefined

@param options - The options of the watcher

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

unregisterSizeWatcher()

Unregister a size watcher

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

@param id - The id of the watcher

Returns
void