Class FloatingUI

Floating UI Class to handle the Floating UI provider utils

Export

Hierarchy-Diagram

UML class diagram of FloatingUI

Legend

icon for a class in the UML class diagram

class

icon for an abstract class in the UML class diagram

abstract class

icon for a protected property in the UML class diagram

protected property

icon for a private property in the UML class diagram

private property

icon for a public method in the UML class diagram

public method

icon for a protected method in the UML class diagram

protected method

italic abstract property/method

Hierarchy

OSFramework.OSUI.Utils.FloatingPosition.FloatingPosition
- FloatingUI

Index

Properties

eventOnUpdateCallback floatingConfigs isBuilt _currentPlacement

Methods

getOffsetValue build update dispose setFloatingPosition unsetFloatingPosition

Constructors

Properties

`Protected` eventOnUpdateCallback

eventOnUpdateCallback: Generic

`Protected` floatingConfigs

floatingConfigs: FloatingPositionConfig

`Protected` isBuilt

isBuilt: boolean

`Private` _currentPlacement

_currentPlacement: OSFramework.OSUI.GlobalEnum.FloatingPosition

Methods

`Protected` getOffsetValue

getOffsetValue(): number
Returns number
Inherited from FloatingPosition.getOffsetValue
- Defined in OSFramework/OSUI/Utils/FloatingPosition/FloatingPosition.ts:31

build

build(): void
Method to build the Util

Memberof
FloatingPosition

Returns void
Inherited from FloatingPosition.build
- Defined in OSFramework/OSUI/Utils/FloatingPosition/FloatingPosition.ts:42

update

update(options: FloatingPositionConfig): void
Method to update the Util

Memberof
FloatingPosition
Parameters
- options: FloatingPositionConfig
Returns void
Inherited from FloatingPosition.update
- Defined in OSFramework/OSUI/Utils/FloatingPosition/FloatingPosition.ts:62

dispose

dispose(): void
Method to destroy the FloatingUI

Memberof
FloatingUI

Returns void
Overrides FloatingPosition.dispose
- Defined in Providers/OSUI/Utils/FloatingUI/FloatingUI.ts:26

setFloatingPosition

setFloatingPosition(): void
Method to call the FloatingUI provider

Memberof
FloatingUI

Returns void
Overrides FloatingPosition.setFloatingPosition
- Defined in Providers/OSUI/Utils/FloatingUI/FloatingUI.ts:39

unsetFloatingPosition

unsetFloatingPosition(): void
Method to run when the target closes. This will clean listeners on the provider side and stop observing the target

Memberof
FloatingUI

Returns void
Overrides FloatingPosition.unsetFloatingPosition
- Defined in Providers/OSUI/Utils/FloatingUI/FloatingUI.ts:165

Constructors

constructor

new FloatingUI(options: FloatingUIConfig): Providers.OSUI.Utils.FloatingUI
Creates an instance of FloatingUI.

Memberof
FloatingUI
Parameters
- options: FloatingUIConfig
Returns Providers.OSUI.Utils.FloatingUI
Overrides FloatingPosition.constructor
- Defined in Providers/OSUI/Utils/FloatingUI/FloatingUI.ts:17