Class Sidebar

Defines the interface for OutSystemsUI Patterns

Export

Implements

Hierarchy-Diagram

Legend

class

abstract class

interface

public property

private property

public method

protected method

private method

italic abstract property/method

Hierarchy

AbstractPattern<SidebarConfig>
- Sidebar

Implements

Index

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/Pattern/AbstractPattern.ts:50

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 ISidebar.equalsToID

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

`Private` _closeSidebar

_closeSidebar(): void
Returns void
- Defined in OSFramework/Pattern/Sidebar/Sidebar.ts:40

`Private` _handleFocusTrap

_handleFocusTrap(): void
Returns void
- Defined in OSFramework/Pattern/Sidebar/Sidebar.ts:64

`Private` _handleGestureEvents

_handleGestureEvents(): void
Returns void
- Defined in OSFramework/Pattern/Sidebar/Sidebar.ts:73

`Private` _onGestureEnd

_onGestureEnd(offsetX: number, offsetY: number, timeTaken: number): void
Parameters
- offsetX: number
- offsetY: number
- timeTaken: number
Returns void
- Defined in OSFramework/Pattern/Sidebar/Sidebar.ts:91

`Private` _onGestureMove

_onGestureMove(x: number, y: number, offsetX: number, offsetY: number, evt: TouchEvent): void
Parameters
- x: number
- y: number
- offsetX: number
- offsetY: number
- evt: TouchEvent
Returns void
- Defined in OSFramework/Pattern/Sidebar/Sidebar.ts:100

`Private` _onGestureStart

_onGestureStart(x: number, y: number): void
Parameters
- x: number
- y: number
Returns void
- Defined in OSFramework/Pattern/Sidebar/Sidebar.ts:109

`Private` _openSidebar

_openSidebar(): void
Returns void
- Defined in OSFramework/Pattern/Sidebar/Sidebar.ts:121

`Private` _overlayClickCallback

_overlayClickCallback(_args: string, e: MouseEvent): void
Parameters
- _args: string
- e: MouseEvent
Returns void
- Defined in OSFramework/Pattern/Sidebar/Sidebar.ts:147

`Private` _removeEvents

_removeEvents(): void
Returns void
- Defined in OSFramework/Pattern/Sidebar/Sidebar.ts:158

`Private` _setDirection

_setDirection(): void
Returns void
- Defined in OSFramework/Pattern/Sidebar/Sidebar.ts:164

`Private` _setHasOverlay

_setHasOverlay(): void
Returns void
- Defined in OSFramework/Pattern/Sidebar/Sidebar.ts:174

`Private` _setInitialCssClasses

_setInitialCssClasses(): void
Returns void
- Defined in OSFramework/Pattern/Sidebar/Sidebar.ts:191

`Private` _setWidth

_setWidth(): void
Returns void
- Defined in OSFramework/Pattern/Sidebar/Sidebar.ts:202

`Private` _sidebarKeypressCallback

_sidebarKeypressCallback(e: KeyboardEvent): void
Parameters
- e: KeyboardEvent
Returns void
- Defined in OSFramework/Pattern/Sidebar/Sidebar.ts:207

`Private` _toggle

_toggle(): void
Returns void
- Defined in OSFramework/Pattern/Sidebar/Sidebar.ts:217

`Private` _toggleGesturesSidebar

_toggleGesturesSidebar(enableSwipes: boolean): void
Parameters
- enableSwipes: boolean
Returns void
- Defined in OSFramework/Pattern/Sidebar/Sidebar.ts:226

`Private` _triggerOnToggleEvent

_triggerOnToggleEvent(): void
Returns void
- Defined in OSFramework/Pattern/Sidebar/Sidebar.ts:237

`Protected` setA11YProperties

setA11YProperties(): void
Protected
Sets the A11Y properties when the pattern is built.

Memberof
OSFramework.Patterns.Sidebar.Sidebar

Returns void
Overrides AbstractPattern.setA11YProperties
- Defined in OSFramework/Pattern/Sidebar/Sidebar.ts:247

`Protected` setCallbacks

setCallbacks(): void
Protected
Sets the callbacks to be used in the pattern.

Memberof
OSFramework.Patterns.Sidebar.Sidebar

Returns void
Overrides AbstractPattern.setCallbacks
- Defined in OSFramework/Pattern/Sidebar/Sidebar.ts:266

`Protected` setHtmlElements

setHtmlElements(): void
Protected
Set the html references that will be used to manage the cssClasses and atribute properties

Memberof
OSFramework.Patterns.Sidebar.Sidebar

Returns void
Overrides AbstractPattern.setHtmlElements
- Defined in OSFramework/Pattern/Sidebar/Sidebar.ts:277

`Protected` unsetCallbacks

unsetCallbacks(): void
Protected
Method to remove all assigned callbacks

Memberof
OSFramework.Patterns.Sidebar.Sidebar

Returns void
Overrides AbstractPattern.unsetCallbacks
- Defined in OSFramework/Pattern/Sidebar/Sidebar.ts:289

`Protected` unsetHtmlElements

unsetHtmlElements(): void
Protected
Release references to HTML elements.

Memberof
OSFramework.Patterns.Sidebar.Sidebar

Returns void
Overrides AbstractPattern.unsetHtmlElements
- Defined in OSFramework/Pattern/Sidebar/Sidebar.ts:302

build

build(): void
Method to build the pattern.

Memberof
OSFramework.Patterns.Sidebar.Sidebar

Returns void
Implementation of ISidebar.build

Overrides AbstractPattern.build
- Defined in OSFramework/Pattern/Sidebar/Sidebar.ts:311

changeProperty

changeProperty(propertyName: string, propertyValue: unknown): void
Method to change the value of configs/current state.

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

Overrides AbstractPattern.changeProperty
- Defined in OSFramework/Pattern/Sidebar/Sidebar.ts:336

close

close(): void
Public method to close the sidebar, if it's open.

Memberof
OSFramework.Patterns.Sidebar.Sidebar

Returns void
Implementation of ISidebar.close
- Defined in OSFramework/Pattern/Sidebar/Sidebar.ts:365

dispose

dispose(): void
Method to remove event listener and destroy sidebar instance

Memberof
OSFramework.Patterns.Sidebar.Sidebar

Returns void
Implementation of ISidebar.dispose

Overrides AbstractPattern.dispose
- Defined in OSFramework/Pattern/Sidebar/Sidebar.ts:376

open

open(): void
Method that opens the sidebar.

Memberof
OSFramework.Patterns.Sidebar.Sidebar

Returns void
Implementation of ISidebar.open
- Defined in OSFramework/Pattern/Sidebar/Sidebar.ts:398

registerCallback

registerCallback(callback: OSFramework.Patterns.Sidebar.Callbacks.OSOnToggleEvent): void
Set callbacks for the onToggle event

Memberof
OSFramework.Patterns.Sidebar.Sidebar
Parameters
- callback: OSFramework.Patterns.Sidebar.Callbacks.OSOnToggleEvent
Returns void
Implementation of ISidebar.registerCallback
- Defined in OSFramework/Pattern/Sidebar/Sidebar.ts:410

removeGestureEvents

removeGestureEvents(): void
Removes the gesture events to open/close the Sidebar on Native Apps

Memberof
OSFramework.Patterns.Sidebar.Sidebar

Returns void
Implementation of IDragEvent.removeGestureEvents
- Defined in OSFramework/Pattern/Sidebar/Sidebar.ts:423

`Protected` setGestureEvents

setGestureEvents(onGestureStartCallback: GestureStart, onGestureMoveCallback: OSFramework.Event.GestureEvent.Callbacks.GestureMove, onGestureEndCallback: OSFramework.Event.GestureEvent.Callbacks.GestureEnd): void
Protected
Sets the gesture events to open/close the Sidebar on Native Apps

Memberof
OSFramework.Patterns.Sidebar.Sidebar
Parameters
- onGestureStartCallback: GestureStart
- onGestureMoveCallback: OSFramework.Event.GestureEvent.Callbacks.GestureMove
- onGestureEndCallback: OSFramework.Event.GestureEvent.Callbacks.GestureEnd
Returns void
Implementation of IDragEvent.setGestureEvents
- Defined in OSFramework/Pattern/Sidebar/Sidebar.ts:439

toggleGestures

toggleGestures(enableSwipe: boolean): void
Method that toggle swipes on sidebar.

Memberof
OSFramework.Patterns.Sidebar.Sidebar
Parameters
- enableSwipe: boolean
Returns void
Implementation of ISidebar.toggleGestures
- Defined in OSFramework/Pattern/Sidebar/Sidebar.ts:457

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/Pattern/AbstractPattern.ts:128

selfElement

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

Memberof
OSFramework.Patterns.AbstractPattern

Returns HTMLElement
Implementation of ISidebar.selfElement

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

isBuilt

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

Memberof
OSFramework.Patterns.AbstractPattern

Returns boolean
Implementation of ISidebar.isBuilt

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

configs

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

Memberof
OSFramework.Patterns.AbstractPattern

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

uniqueId

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

Memberof
OSFramework.Patterns.AbstractPattern

Returns string
Implementation of ISidebar.uniqueId

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

widgetId

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

Memberof
OSFramework.Patterns.AbstractPattern

Returns string
Implementation of ISidebar.widgetId

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

gestureEventInstance

get gestureEventInstance(): DragEvent
Get Gesture Events Instance

Memberof
OSFramework.Patterns.Sidebar.Sidebar

Returns DragEvent
Implementation of IDragEvent.gestureEventInstance
- Defined in OSFramework/Pattern/Sidebar/Sidebar.ts:468

hasGestureEvents

get hasGestureEvents(): boolean
Get if has gesture events

Memberof
OSFramework.Patterns.Sidebar.Sidebar

Returns boolean
Implementation of IDragEvent.hasGestureEvents
- Defined in OSFramework/Pattern/Sidebar/Sidebar.ts:479

Properties

`Private` _animateOnDragInstance

_animateOnDragInstance: AnimateOnDrag

`Private` _currentDirectionCssClass

_currentDirectionCssClass: string

`Private` _eventOverlayClick

_eventOverlayClick: Generic

`Private` _eventSidebarKeypress

_eventSidebarKeypress: Generic

`Private` _focusTrapInstance

_focusTrapInstance: FocusTrap

`Private` _gestureEventInstance

_gestureEventInstance: DragEvent

`Private` _hasGestureEvents

_hasGestureEvents: boolean

`Private` _isOpen

_isOpen: boolean

`Private` _onToggle

_onToggle: OSFramework.Patterns.Sidebar.Callbacks.OSOnToggleEvent

`Private` _parentSelf

_parentSelf: HTMLElement

Constructors

constructor

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

Class Sidebar

Export

Implements

Hierarchy-Diagram

Legend

Hierarchy

Implements

Index

Methods

Accessors

Properties

Constructors

Methods

Protected finishBuild

Memberof

Returns void

equalsToID

Returns

Memberof

Parameters

patternId: string

Returns boolean

Private _closeSidebar

Returns void

Private _handleFocusTrap

Returns void

Private _handleGestureEvents

Returns void

Private _onGestureEnd

Parameters

offsetX: number

offsetY: number

timeTaken: number

Returns void

Private _onGestureMove

Parameters

x: number

y: number

offsetX: number

offsetY: number

evt: TouchEvent

Returns void

Private _onGestureStart

Parameters

x: number

y: number

Returns void

Private _openSidebar

Returns void

Private _overlayClickCallback

Parameters

_args: string

e: MouseEvent

Returns void

Private _removeEvents

Returns void

Private _setDirection

Returns void

Private _setHasOverlay

Returns void

Private _setInitialCssClasses

Returns void

Private _setWidth

Returns void

Private _sidebarKeypressCallback

Parameters

e: KeyboardEvent

Returns void

Private _toggle

Returns void

Private _toggleGesturesSidebar

Parameters

enableSwipes: boolean

Returns void

Private _triggerOnToggleEvent

Returns void

Protected setA11YProperties

Memberof

Returns void

Protected setCallbacks

`Protected` finishBuild

`Private` _closeSidebar

`Private` _handleFocusTrap

`Private` _handleGestureEvents

`Private` _onGestureEnd

`Private` _onGestureMove

`Private` _onGestureStart

`Private` _openSidebar

`Private` _overlayClickCallback

`Private` _removeEvents

`Private` _setDirection

`Private` _setHasOverlay

`Private` _setInitialCssClasses

`Private` _setWidth

`Private` _sidebarKeypressCallback

`Private` _toggle

`Private` _toggleGesturesSidebar

`Private` _triggerOnToggleEvent

`Protected` setA11YProperties

`Protected` setCallbacks

`Protected` setHtmlElements

`Protected` unsetCallbacks

`Protected` unsetHtmlElements

`Protected` setGestureEvents

`Protected` _enableAccessibility