Class BottomSheet

Class that implements the BottomSheet pattern.

Export

BottomSheet

Implements

Hierarchy (View Summary)

AbstractPattern<BottomSheetConfig>
- BottomSheet

Implements

Constructors

constructor

new BottomSheet(
uniqueId: string,
configs: JSON,
): OSFramework.OSUI.Patterns.BottomSheet.BottomSheet
Parameters
- uniqueId: string
- configs: JSON
Returns OSFramework.OSUI.Patterns.BottomSheet.BottomSheet
Overrides AbstractPattern.constructor
- Defined in OSFramework/OSUI/Pattern/BottomSheet/BottomSheet.ts:67

Properties

`Protected`isProviderBased

isProviderBased: boolean = false

springAnimationConfigs

springAnimationConfigs: {
    addSpringAnimation: boolean;
    springAnimationProperties: {
        tension: number;
        friction: number;
        mass: number;
    };
} = ...

Accessors

`Protected`_enableAccessibility

get _enableAccessibility(): boolean
Protected
Getter that allows to obtain the accessibility is enabled.

Returns boolean

Memberof
OSFramework.Patterns.AbstractPattern
Inherited from AbstractPattern._enableAccessibility
- Defined in OSFramework/OSUI/Pattern/AbstractPattern.ts:207

selfElement

get selfElement(): HTMLElement
Getter that allows to obtain the self element.

Returns HTMLElement

Memberof
OSFramework.Patterns.AbstractPattern
Implementation of IBottomSheet.selfElement

Inherited from AbstractPattern.selfElement
- Defined in OSFramework/OSUI/Pattern/AbstractPattern.ts:218

isBuilt

get isBuilt(): boolean
Getter that tells if the pattern is already built.

Returns boolean

Memberof
OSFramework.Patterns.AbstractPattern
Implementation of IBottomSheet.isBuilt

Inherited from AbstractPattern.isBuilt
- Defined in OSFramework/OSUI/Pattern/AbstractPattern.ts:229

configs

get configs(): C
Current configurations/state of the pattern.

Returns C

Memberof
OSFramework.Patterns.AbstractPattern
Inherited from AbstractPattern.configs
- Defined in OSFramework/OSUI/Pattern/AbstractPattern.ts:240

uniqueId

get uniqueId(): string
Unique id of the pattern. Internal use only.

Returns string

Memberof
OSFramework.Patterns.AbstractPattern
Implementation of IBottomSheet.uniqueId

Inherited from AbstractPattern.uniqueId
- Defined in OSFramework/OSUI/Pattern/AbstractPattern.ts:251

widgetId

get widgetId(): string
Id of the pattern known by the developer. External use only.

Returns string

Memberof
OSFramework.Patterns.AbstractPattern
Implementation of IBottomSheet.widgetId

Inherited from AbstractPattern.widgetId
- Defined in OSFramework/OSUI/Pattern/AbstractPattern.ts:262

gestureEventInstance

get gestureEventInstance(): DragEvent
Method to get Gesture Events Instance

Returns DragEvent

Memberof
OSFramework.Patterns.BottomSheet.BottomSheet
Implementation of IDragEvent.gestureEventInstance
- Defined in OSFramework/OSUI/Pattern/BottomSheet/BottomSheet.ts:52

hasGestureEvents

get hasGestureEvents(): boolean
Method to get if has gesture events

Returns boolean

Memberof
OSFramework.Patterns.BottomSheet.BottomSheet
Implementation of IDragEvent.hasGestureEvents
- Defined in OSFramework/OSUI/Pattern/BottomSheet/BottomSheet.ts:63

Methods

`Protected`finishBuild

finishBuild(): void
Protected
Marks the built as being finished.

Returns void

Memberof
OSFramework.Patterns.AbstractPattern
Inherited from AbstractPattern.finishBuild
- Defined in OSFramework/OSUI/Pattern/AbstractPattern.ts:61

`Protected`triggerPlatformEventCallback

triggerPlatformEventCallback(
platFormCallback: OSGeneric,
...args: unknown[],
): void
Protected
Triggers a generic platform event.
Parameters
- platFormCallback: OSGeneric
- ...args: unknown[]
Returns void

Memberof
AbstractProviderPattern
Inherited from AbstractPattern.triggerPlatformEventCallback
- Defined in OSFramework/OSUI/Pattern/AbstractPattern.ts:81

`Protected`triggerPlatformInitializedEventCallback

triggerPlatformInitializedEventCallback(): void
Protected
Trigger the Initialized callback platform event.

Returns void

Memberof
AbstractPattern
Inherited from AbstractPattern.triggerPlatformInitializedEventCallback
- Defined in OSFramework/OSUI/Pattern/AbstractPattern.ts:93

`Protected`unsetGlobalCallbacks

unsetGlobalCallbacks(): void
Protected
Unsets the global callbacks. This naming is used to prevent overriding the unsetCallback method on all patterns

Returns void

Memberof
OSFramework.Patterns.AbstractPattern
Inherited from AbstractPattern.unsetGlobalCallbacks
- Defined in OSFramework/OSUI/Pattern/AbstractPattern.ts:107

equalsToID

equalsToID(patternId: string): boolean
Enables to uniquely identify the pattern in all ways.
Parameters
- patternId: string
Returns boolean
{boolean}

Memberof
OSFramework.Patterns.AbstractPattern
Implementation of IBottomSheet.equalsToID

Inherited from AbstractPattern.equalsToID
- Defined in OSFramework/OSUI/Pattern/AbstractPattern.ts:172

`Protected`removeEventListeners

removeEventListeners(): void
Protected
Method to remove the event listeners

Returns void

Memberof
OSFramework.Patterns.BottomSheet.BottomSheet
- Defined in OSFramework/OSUI/Pattern/BottomSheet/BottomSheet.ts:229

`Protected`setA11YProperties

setA11YProperties(): void
Protected
Method to add the Accessibility Attributes values

Returns void

Memberof
OSFramework.Patterns.BottomSheet.BottomSheet
Overrides AbstractPattern.setA11YProperties
- Defined in OSFramework/OSUI/Pattern/BottomSheet/BottomSheet.ts:242

`Protected`setCallbacks

setCallbacks(): void
Protected
Method to set the listeners and platform event callbacks

Returns void

Memberof
OSFramework.Patterns.BottomSheet.BottomSheet
Overrides AbstractPattern.setCallbacks
- Defined in OSFramework/OSUI/Pattern/BottomSheet/BottomSheet.ts:262

`Protected`setEventListeners

setEventListeners(): void
Protected
Method to add event listeners

Returns void

Memberof
OSFramework.Patterns.BottomSheet.BottomSheet
- Defined in OSFramework/OSUI/Pattern/BottomSheet/BottomSheet.ts:273

`Protected`setHtmlElements

setHtmlElements(): void
Protected
Method to update info based on htmlContent

Returns void

Memberof
OSFramework.Patterns.BottomSheet.BottomSheet
Overrides AbstractPattern.setHtmlElements
- Defined in OSFramework/OSUI/Pattern/BottomSheet/BottomSheet.ts:293

`Protected`setInitialOptions

setInitialOptions(): void
Protected
Method to set initial options

Returns void

Memberof
OSFramework.Patterns.BottomSheet.BottomSheet
- Defined in OSFramework/OSUI/Pattern/BottomSheet/BottomSheet.ts:305

`Protected`unsetCallbacks

unsetCallbacks(): void
Protected
Method to unset callbacks

Returns void

Memberof
OSFramework.Patterns.BottomSheet.BottomSheet
Overrides AbstractPattern.unsetCallbacks
- Defined in OSFramework/OSUI/Pattern/BottomSheet/BottomSheet.ts:316

`Protected`unsetHtmlElements

unsetHtmlElements(): void
Protected
Method to remove the local value of the variables pointing to HTML elements;

Returns void

Memberof
OSFramework.Patterns.BottomSheet.BottomSheet
Overrides AbstractPattern.unsetHtmlElements
- Defined in OSFramework/OSUI/Pattern/BottomSheet/BottomSheet.ts:328

build

build(): void
Method to build the BottomSheet.

Returns void

Memberof
OSFramework.Patterns.BottomSheet.BottomSheet
Implementation of IBottomSheet.build

Overrides AbstractPattern.build
- Defined in OSFramework/OSUI/Pattern/BottomSheet/BottomSheet.ts:339

changeProperty

changeProperty(propertyName: string, propertyValue: unknown): void
Method to apply the changes of state/value of the configurations.
Parameters
- propertyName: string
- propertyValue: unknown
Returns void

Memberof
OSFramework.Patterns.BottomSheet.BottomSheet
Implementation of IBottomSheet.changeProperty

Overrides AbstractPattern.changeProperty
- Defined in OSFramework/OSUI/Pattern/BottomSheet/BottomSheet.ts:357

close

close(): void
Method to close the BottomSHeet

Returns void

Memberof
OSFramework.Patterns.BottomSheet.BottomSheet
Implementation of IBottomSheet.close
- Defined in OSFramework/OSUI/Pattern/BottomSheet/BottomSheet.ts:378

dispose

dispose(): void
Method to destroy pattern.

Returns void

Memberof
OSFramework.Patterns.BottomSheet.BottomSheet
Implementation of IBottomSheet.dispose

Overrides AbstractPattern.dispose
- Defined in OSFramework/OSUI/Pattern/BottomSheet/BottomSheet.ts:389

open

open(): void
Method to open the BottomSheet

Returns void

Memberof
OSFramework.Patterns.BottomSheet.BottomSheet
Implementation of IBottomSheet.open
- Defined in OSFramework/OSUI/Pattern/BottomSheet/BottomSheet.ts:410

registerCallback

registerCallback(eventName: string, callback: OSGeneric): void
Method to register a given callback event handler.
Parameters
- eventName: string
- callback: OSGeneric
Returns void

Memberof
OSFramework.Patterns.BottomSheet.BottomSheet
Implementation of IBottomSheet.registerCallback

Overrides AbstractPattern.registerCallback
- Defined in OSFramework/OSUI/Pattern/BottomSheet/BottomSheet.ts:423

removeGestureEvents

removeGestureEvents(): void
Method to remove the gesture events to open/close the BottomSheet on Native Apps

Returns void

Memberof
OSFramework.Patterns.BottomSheet.BottomSheet
Implementation of IDragEvent.removeGestureEvents
- Defined in OSFramework/OSUI/Pattern/BottomSheet/BottomSheet.ts:440

`Protected`setGestureEvents

setGestureEvents(
    onGestureStart: GestureStart,
    onGestureMove: OSFramework.OSUI.Event.GestureEvent.Callbacks.GestureMove,
    onGestureEnd: OSFramework.OSUI.Event.GestureEvent.Callbacks.GestureEnd,
): void
Protected
Method to set the gesture events to open/close the BottomSheet on Native Apps
Parameters
- onGestureStart: GestureStart
- onGestureMove: OSFramework.OSUI.Event.GestureEvent.Callbacks.GestureMove
- onGestureEnd: OSFramework.OSUI.Event.GestureEvent.Callbacks.GestureEnd
Returns void

Memberof
OSFramework.Patterns.BottomSheet.BottomSheet
Implementation of IDragEvent.setGestureEvents
- Defined in OSFramework/OSUI/Pattern/BottomSheet/BottomSheet.ts:456

Class BottomSheet

Export

Implements

Hierarchy (View Summary)

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns OSFramework.OSUI.Patterns.BottomSheet.BottomSheet

Properties

ProtectedisProviderBased

springAnimationConfigs

Accessors

Protected_enableAccessibility

Returns boolean

Memberof

selfElement

Returns HTMLElement

Memberof

isBuilt

Returns boolean

Memberof

configs

Returns C

Memberof

uniqueId

Returns string

Memberof

widgetId

Returns string

Memberof

gestureEventInstance

Returns DragEvent

Memberof

hasGestureEvents

Returns boolean

Memberof

Methods

ProtectedfinishBuild

Returns void

Memberof

ProtectedtriggerPlatformEventCallback

Parameters

Returns void

Memberof

ProtectedtriggerPlatformInitializedEventCallback

Returns void

Memberof

ProtectedunsetGlobalCallbacks

Returns void

Memberof

equalsToID

Parameters

Returns boolean

Memberof

ProtectedremoveEventListeners

Returns void

Memberof

ProtectedsetA11YProperties

Returns void

Memberof

ProtectedsetCallbacks

Returns void

Memberof

ProtectedsetEventListeners

Returns void

Memberof

ProtectedsetHtmlElements

Returns void

Memberof

ProtectedsetInitialOptions

Returns void

Memberof

ProtectedunsetCallbacks

Returns void

`Protected`isProviderBased

`Protected`_enableAccessibility

`Protected`finishBuild

`Protected`triggerPlatformEventCallback

`Protected`triggerPlatformInitializedEventCallback

`Protected`unsetGlobalCallbacks

`Protected`removeEventListeners

`Protected`setA11YProperties

`Protected`setCallbacks

`Protected`setEventListeners

`Protected`setHtmlElements

`Protected`setInitialOptions

`Protected`unsetCallbacks

`Protected`unsetHtmlElements

`Protected`setGestureEvents