Class BottomSheet

Class that implements the BottomSheet pattern.

Export

Implements

Hierarchy-Diagram

Legend

class

abstract class

interface

public property

protected property

private property

public method

protected method

private method

italic abstract property/method

Hierarchy

AbstractPattern<BottomSheetConfig>
- BottomSheet

Implements

Index

Properties

`Protected` isProviderBased

isProviderBased: boolean = false

`Private` _animateOnDragInstance

_animateOnDragInstance: AnimateOnDrag

`Private` _bottomSheetContentElem

_bottomSheetContentElem: HTMLElement

`Private` _bottomSheetHeaderElem

_bottomSheetHeaderElem: HTMLElement

`Private` _eventOnContentScroll

_eventOnContentScroll: Generic

`Private` _eventOnKeypress

_eventOnKeypress: Generic

`Private` _focusManagerInstance

_focusManagerInstance: FocusManager

`Private` _focusTrapInstance

_focusTrapInstance: FocusTrap

`Private` _gestureEventInstance

_gestureEventInstance: DragEvent

`Private` _hasGestureEvents

_hasGestureEvents: boolean

`Private` _isOpen

_isOpen: boolean = false

`Private` _parentSelf

_parentSelf: HTMLElement

`Private` _platformEventOnToggle

_platformEventOnToggle: OSFramework.OSUI.Patterns.BottomSheet.Callbacks.OSOnToggleEvent

springAnimationConfigs

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

Type declaration

addSpringAnimation: boolean
springAnimationProperties: {
    tension: number;
    friction: number;
    mass: number;
}
- tension: number
- friction: number
- mass: number

Methods

`Protected` finishBuild

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

Memberof
OSFramework.Patterns.AbstractPattern

Returns void
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.

Memberof
AbstractProviderPattern
Parameters
- platFormCallback: OSGeneric
- Rest ...args: unknown[]
Returns void
Inherited from AbstractPattern.triggerPlatformEventCallback
- Defined in OSFramework/OSUI/Pattern/AbstractPattern.ts:81

`Protected` triggerPlatformInitializedEventCallback

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

Memberof
AbstractPattern

Returns void
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

Memberof
OSFramework.Patterns.AbstractPattern

Returns void
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.

Returns
{boolean}

Memberof
OSFramework.Patterns.AbstractPattern
Parameters
- patternId: string
Returns boolean
Implementation of IBottomSheet.equalsToID

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

`Private` _handleFocusBehavior

_handleFocusBehavior(): void
Private
Method to add Focus Trap to Pattern

Memberof
BottomSheet

Returns void
- Defined in OSFramework/OSUI/Pattern/BottomSheet/BottomSheet.ts:77

`Private` _handleGestureEvents

_handleGestureEvents(): void
Private
Method to handle the creation of the GestureEvents

Memberof
BottomSheet

Returns void
- Defined in OSFramework/OSUI/Pattern/BottomSheet/BottomSheet.ts:94

`Private` _handleShape

_handleShape(shape: OSFramework.OSUI.GlobalEnum.ShapeTypes): void
Private
Method to handle the Shape config css variable

Memberof
BottomSheet
Parameters
- shape: OSFramework.OSUI.GlobalEnum.ShapeTypes
Returns void
- Defined in OSFramework/OSUI/Pattern/BottomSheet/BottomSheet.ts:112

`Private` _onContentScrollCallback

_onContentScrollCallback(): void
Private
Method to be called as callback on scroll event, to toggle class on BottomSheet when it has scroll active

Memberof
BottomSheet

Returns void
- Defined in OSFramework/OSUI/Pattern/BottomSheet/BottomSheet.ts:126

`Private` _onGestureEnd

_onGestureEnd(offsetX: number, offsetY: number, timeTaken: number): void
Private
Method to handle the start of a gesture

Memberof
BottomSheet
Parameters
- offsetX: number
- offsetY: number
- timeTaken: number
Returns void
- Defined in OSFramework/OSUI/Pattern/BottomSheet/BottomSheet.ts:143

`Private` _onGestureMove

_onGestureMove(x: number, y: number, offsetX: number, offsetY: number, evt: TouchEvent): void
Private
Method to handle the gesture move

Memberof
BottomSheet
Parameters
- x: number
- y: number
- offsetX: number
- offsetY: number
- evt: TouchEvent
Returns void
- Defined in OSFramework/OSUI/Pattern/BottomSheet/BottomSheet.ts:164

`Private` _onGestureStart

_onGestureStart(x: number, y: number): void
Private
Method to handle the end of a gesture

Memberof
BottomSheet
Parameters
- x: number
- y: number
Returns void
- Defined in OSFramework/OSUI/Pattern/BottomSheet/BottomSheet.ts:176

`Private` _onkeypressCallback

_onkeypressCallback(e: KeyboardEvent): void
Private
Method to call open or close, based on e.key and behaviour applied

Memberof
BottomSheet
Parameters
- e: KeyboardEvent
Returns void
- Defined in OSFramework/OSUI/Pattern/BottomSheet/BottomSheet.ts:194

`Private` _toggleBottomSheet

_toggleBottomSheet(isOpen: boolean): void
Private
Method to toggle the open/close the BottomSheet

Memberof
BottomSheet
Parameters
- isOpen: boolean
Returns void
- Defined in OSFramework/OSUI/Pattern/BottomSheet/BottomSheet.ts:221

`Private` _toggleHandler

_toggleHandler(ShowHandler: boolean): void
Private
Method that toggles the showHandler config

Memberof
BottomSheet
Parameters
- ShowHandler: boolean
Returns void
- Defined in OSFramework/OSUI/Pattern/BottomSheet/BottomSheet.ts:270

`Private` _triggerOnToggleEvent

_triggerOnToggleEvent(): void
Private
Method that triggers the OnToggle event

Memberof
BottomSheet

Returns void
- Defined in OSFramework/OSUI/Pattern/BottomSheet/BottomSheet.ts:284

`Protected` removeEventListeners

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

Memberof
OSFramework.Patterns.BottomSheet.BottomSheet

Returns void
- Defined in OSFramework/OSUI/Pattern/BottomSheet/BottomSheet.ts:294

`Protected` setA11YProperties

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

Memberof
OSFramework.Patterns.BottomSheet.BottomSheet

Returns void
Overrides AbstractPattern.setA11YProperties
- Defined in OSFramework/OSUI/Pattern/BottomSheet/BottomSheet.ts:307

`Protected` setCallbacks

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

Memberof
OSFramework.Patterns.BottomSheet.BottomSheet

Returns void
Overrides AbstractPattern.setCallbacks
- Defined in OSFramework/OSUI/Pattern/BottomSheet/BottomSheet.ts:336

`Protected` setEventListeners

setEventListeners(): void
Protected
Method to add event listeners

Memberof
OSFramework.Patterns.BottomSheet.BottomSheet

Returns void
- Defined in OSFramework/OSUI/Pattern/BottomSheet/BottomSheet.ts:347

`Protected` setHtmlElements

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

Memberof
OSFramework.Patterns.BottomSheet.BottomSheet

Returns void
Overrides AbstractPattern.setHtmlElements
- Defined in OSFramework/OSUI/Pattern/BottomSheet/BottomSheet.ts:367

`Protected` setInitialOptions

setInitialOptions(): void
Protected
Method to set initial options

Memberof
OSFramework.Patterns.BottomSheet.BottomSheet

Returns void
- Defined in OSFramework/OSUI/Pattern/BottomSheet/BottomSheet.ts:379

`Protected` unsetCallbacks

unsetCallbacks(): void
Protected
Method to unset callbacks

Memberof
OSFramework.Patterns.BottomSheet.BottomSheet

Returns void
Overrides AbstractPattern.unsetCallbacks
- Defined in OSFramework/OSUI/Pattern/BottomSheet/BottomSheet.ts:390

`Protected` unsetHtmlElements

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

Memberof
OSFramework.Patterns.BottomSheet.BottomSheet

Returns void
Overrides AbstractPattern.unsetHtmlElements
- Defined in OSFramework/OSUI/Pattern/BottomSheet/BottomSheet.ts:402

build

build(): void
Method to build the BottomSheet.

Memberof
OSFramework.Patterns.BottomSheet.BottomSheet

Returns void
Implementation of IBottomSheet.build

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

changeProperty

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

Memberof
OSFramework.Patterns.BottomSheet.BottomSheet
Parameters
- propertyName: string
- propertyValue: unknown
Returns void
Implementation of IBottomSheet.changeProperty

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

close

close(): void
Method to close the BottomSHeet

Memberof
OSFramework.Patterns.BottomSheet.BottomSheet

Returns void
Implementation of IBottomSheet.close
- Defined in OSFramework/OSUI/Pattern/BottomSheet/BottomSheet.ts:452

dispose

dispose(): void
Method to destroy pattern.

Memberof
OSFramework.Patterns.BottomSheet.BottomSheet

Returns void
Implementation of IBottomSheet.dispose

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

open

open(): void
Method to open the BottomSheet

Memberof
OSFramework.Patterns.BottomSheet.BottomSheet

Returns void
Implementation of IBottomSheet.open
- Defined in OSFramework/OSUI/Pattern/BottomSheet/BottomSheet.ts:483

registerCallback

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

Memberof
OSFramework.Patterns.BottomSheet.BottomSheet
Parameters
- eventName: string
- callback: OSGeneric
Returns void
Implementation of IBottomSheet.registerCallback

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

removeGestureEvents

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

Memberof
OSFramework.Patterns.BottomSheet.BottomSheet

Returns void
Implementation of IDragEvent.removeGestureEvents
- Defined in OSFramework/OSUI/Pattern/BottomSheet/BottomSheet.ts:513

`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

Memberof
OSFramework.Patterns.BottomSheet.BottomSheet
Parameters
- onGestureStart: GestureStart
- onGestureMove: OSFramework.OSUI.Event.GestureEvent.Callbacks.GestureMove
- onGestureEnd: OSFramework.OSUI.Event.GestureEvent.Callbacks.GestureEnd
Returns void
Implementation of IDragEvent.setGestureEvents
- Defined in OSFramework/OSUI/Pattern/BottomSheet/BottomSheet.ts:529

Accessors

`Protected` _enableAccessibility

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

Memberof
OSFramework.Patterns.AbstractPattern

Returns boolean
Inherited from AbstractPattern._enableAccessibility
- Defined in OSFramework/OSUI/Pattern/AbstractPattern.ts:207

selfElement

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

Memberof
OSFramework.Patterns.AbstractPattern

Returns HTMLElement
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.

Memberof
OSFramework.Patterns.AbstractPattern

Returns boolean
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.

Memberof
OSFramework.Patterns.AbstractPattern

Returns C
Inherited from AbstractPattern.configs
- Defined in OSFramework/OSUI/Pattern/AbstractPattern.ts:240

uniqueId

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

Memberof
OSFramework.Patterns.AbstractPattern

Returns string
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.

Memberof
OSFramework.Patterns.AbstractPattern

Returns string
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

Memberof
OSFramework.Patterns.BottomSheet.BottomSheet

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

hasGestureEvents

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

Memberof
OSFramework.Patterns.BottomSheet.BottomSheet

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

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

Class BottomSheet

Export

Implements

Hierarchy-Diagram

Legend

Hierarchy

Implements

Index

Properties

Methods

Accessors

Constructors

Properties

Protected isProviderBased

Private _animateOnDragInstance

Private _bottomSheetContentElem

Private _bottomSheetHeaderElem

Private _eventOnContentScroll

Private _eventOnKeypress

Private _focusManagerInstance

Private _focusTrapInstance

Private _gestureEventInstance

Private _hasGestureEvents

Private _isOpen

Private _parentSelf

Private _platformEventOnToggle

springAnimationConfigs

Type declaration

addSpringAnimation: boolean

springAnimationProperties: { tension: number; friction: number; mass: number; }

tension: number

friction: number

mass: number

Methods

Protected finishBuild

Memberof

Returns void

Protected triggerPlatformEventCallback

Memberof

Parameters

platFormCallback: OSGeneric

Rest ...args: unknown[]

Returns void

Protected triggerPlatformInitializedEventCallback

Memberof

Returns void

Protected unsetGlobalCallbacks

Memberof

Returns void

equalsToID

Returns

Memberof

Parameters

patternId: string

Returns boolean

Private _handleFocusBehavior

Memberof

Returns void

Private _handleGestureEvents

Memberof

Returns void

Private _handleShape

Memberof

Parameters

shape: OSFramework.OSUI.GlobalEnum.ShapeTypes

Returns void

Private _onContentScrollCallback

Memberof

Returns void

Private _onGestureEnd

Memberof

Parameters

offsetX: number

offsetY: number

timeTaken: number

Returns void

Private _onGestureMove

Memberof

Parameters

x: number

`Protected` isProviderBased

`Private` _animateOnDragInstance

`Private` _bottomSheetContentElem

`Private` _bottomSheetHeaderElem

`Private` _eventOnContentScroll

`Private` _eventOnKeypress

`Private` _focusManagerInstance

`Private` _focusTrapInstance

`Private` _gestureEventInstance

`Private` _hasGestureEvents

`Private` _isOpen

`Private` _parentSelf

`Private` _platformEventOnToggle

springAnimationProperties: {
tension: number;
friction: number;
mass: number;
}

`Protected` finishBuild

`Protected` triggerPlatformEventCallback

`Rest` ...args: unknown[]

`Protected` triggerPlatformInitializedEventCallback

`Protected` unsetGlobalCallbacks

`Private` _handleFocusBehavior

`Private` _handleGestureEvents

`Private` _handleShape

`Private` _onContentScrollCallback

`Private` _onGestureEnd

`Private` _onGestureMove

`Private` _onGestureStart

`Private` _onkeypressCallback

`Private` _toggleBottomSheet

`Private` _toggleHandler

`Private` _triggerOnToggleEvent

`Protected` removeEventListeners

`Protected` setA11YProperties

`Protected` setCallbacks

`Protected` setEventListeners

`Protected` setHtmlElements

`Protected` setInitialOptions

`Protected` unsetCallbacks

`Protected` unsetHtmlElements