Class Sidebar

Defines the interface for OutSystemsUI Patterns

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<SidebarConfig>
- Sidebar

Implements

Index

Properties

`Protected` isProviderBased

isProviderBased: boolean = false

`Private` _animateOnDragInstance

_animateOnDragInstance: AnimateOnDrag

`Private` _clickOutsideToClose

_clickOutsideToClose: boolean

`Private` _clickedOutsideElement

_clickedOutsideElement: boolean

`Private` _currentDirectionCssClass

_currentDirectionCssClass: string

`Private` _eventOverlayClick

_eventOverlayClick: Generic

`Private` _eventOverlayMouseDown

_eventOverlayMouseDown: Generic

`Private` _eventSidebarKeypress

_eventSidebarKeypress: Generic

`Private` _focusManagerInstance

_focusManagerInstance: FocusManager

`Private` _focusTrapInstance

_focusTrapInstance: FocusTrap

`Private` _gestureEventInstance

_gestureEventInstance: DragEvent

`Private` _hasGestureEvents

_hasGestureEvents: boolean

`Private` _isOpen

_isOpen: boolean

`Private` _parentSelf

_parentSelf: HTMLElement

`Private` _platformEventOnToggle

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

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

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

`Private` _closeSidebar

_closeSidebar(): void
Private
Method to close Sidebar

Memberof
Sidebar

Returns void
- Defined in OSFramework/OSUI/Pattern/Sidebar/Sidebar.ts:53

`Private` _handleFocusBehavior

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

Memberof
Sidebar

Returns void
- Defined in OSFramework/OSUI/Pattern/Sidebar/Sidebar.ts:90

`Private` _handleGestureEvents

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

Memberof
Sidebar

Returns void
- Defined in OSFramework/OSUI/Pattern/Sidebar/Sidebar.ts:113

`Private` _onGestureEnd

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

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

`Private` _onGestureMove

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

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

`Private` _onGestureStart

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

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

`Private` _openSidebar

_openSidebar(): void
Private
Method to open Sidebar

Memberof
Sidebar

Returns void
- Defined in OSFramework/OSUI/Pattern/Sidebar/Sidebar.ts:191

`Private` _overlayClickCallback

_overlayClickCallback(_args: string, e: MouseEvent): void
Private
Method to close Sidebar on an overlay click

Memberof
Sidebar
Parameters
- _args: string
- e: MouseEvent
Returns void
- Defined in OSFramework/OSUI/Pattern/Sidebar/Sidebar.ts:233

`Private` _overlayMouseDownCallback

_overlayMouseDownCallback(_args: string, e: MouseEvent): void
Private
Method to check if the mouse down event happened outside the sidebar This is required to cover the cases when selecting text and moving the cursor to the sidebar's overlay.

Memberof
Sidebar
Parameters
- _args: string
- e: MouseEvent
Returns void
- Defined in OSFramework/OSUI/Pattern/Sidebar/Sidebar.ts:254

`Private` _removeEvents

_removeEvents(): void
Private
Method to remove the event listeners

Memberof
Sidebar

Returns void
- Defined in OSFramework/OSUI/Pattern/Sidebar/Sidebar.ts:272

`Private` _setDirection

_setDirection(): void
Private
Method to set the Sidebar opening/closing direction

Memberof
Sidebar

Returns void
- Defined in OSFramework/OSUI/Pattern/Sidebar/Sidebar.ts:290

`Private` _setHasOverlay

_setHasOverlay(): void
Private
Method to sets the Sidebar overlay

Memberof
Sidebar

Returns void
- Defined in OSFramework/OSUI/Pattern/Sidebar/Sidebar.ts:305

`Private` _setInitialCssClasses

_setInitialCssClasses(): void
Private
Method to set the cssClasses that should be assigned to the element on it's initialization

Memberof
Sidebar

Returns void
- Defined in OSFramework/OSUI/Pattern/Sidebar/Sidebar.ts:321

`Private` _setWidth

_setWidth(): void
Private
Method to set the Sidebar width

Memberof
Sidebar

Returns void
- Defined in OSFramework/OSUI/Pattern/Sidebar/Sidebar.ts:337

`Private` _sidebarKeypressCallback

_sidebarKeypressCallback(e: KeyboardEvent): void
Private
Method that will handle the tab navigation and sidebar closing on Escape

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

`Private` _toggle

_toggle(): void
Private
Method to toggle the Sidebar

Memberof
Sidebar

Returns void
- Defined in OSFramework/OSUI/Pattern/Sidebar/Sidebar.ts:365

`Private` _toggleGesturesSidebar

_toggleGesturesSidebar(enableSwipes: boolean): void
Private
Method to toggle gestures on Sidebar

Memberof
Sidebar
Parameters
- enableSwipes: boolean
Returns void
- Defined in OSFramework/OSUI/Pattern/Sidebar/Sidebar.ts:380

`Private` _triggerOnToggleEvent

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

Memberof
Sidebar

Returns void
- Defined in OSFramework/OSUI/Pattern/Sidebar/Sidebar.ts:396

`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/OSUI/Pattern/Sidebar/Sidebar.ts:406

`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/OSUI/Pattern/Sidebar/Sidebar.ts:427

`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/OSUI/Pattern/Sidebar/Sidebar.ts:439

`Protected` unsetCallbacks

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

Memberof
OSFramework.Patterns.Sidebar.Sidebar

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

`Protected` unsetHtmlElements

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

Memberof
OSFramework.Patterns.Sidebar.Sidebar

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

build

build(): void
Method to build the Sidebar

Memberof
OSFramework.Patterns.Sidebar.Sidebar

Returns void
Implementation of ISidebar.build

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

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/OSUI/Pattern/Sidebar/Sidebar.ts:500

clickOutsideToClose

clickOutsideToClose(closeOnOutSideClick: boolean): void
Public method to toggle the click on outside to close the sidebar.

Memberof
OSFramework.Patterns.Sidebar.Sidebar
Parameters
- closeOnOutSideClick: boolean
Returns void
Implementation of ISidebar.clickOutsideToClose
- Defined in OSFramework/OSUI/Pattern/Sidebar/Sidebar.ts:529

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/OSUI/Pattern/Sidebar/Sidebar.ts:538

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/OSUI/Pattern/Sidebar/Sidebar.ts:549

open

open(): void
Method that opens the sidebar.

Memberof
OSFramework.Patterns.Sidebar.Sidebar

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

registerCallback

registerCallback(eventName: string, callback: OSGeneric): void
Method to set the callbacks for the pattern

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

Overrides AbstractPattern.registerCallback
- Defined in OSFramework/OSUI/Pattern/Sidebar/Sidebar.ts:584

removeGestureEvents

removeGestureEvents(): void
Method that 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/OSUI/Pattern/Sidebar/Sidebar.ts:604

`Protected` setGestureEvents

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

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

toggleGestures

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

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

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

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

gestureEventInstance

get gestureEventInstance(): DragEvent
Get Gesture Events Instance

Memberof
OSFramework.Patterns.Sidebar.Sidebar

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

hasGestureEvents

get hasGestureEvents(): boolean
Get if has gesture events

Memberof
OSFramework.Patterns.Sidebar.Sidebar

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

Constructors

constructor

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

Class Sidebar

Export

Implements

Hierarchy-Diagram

Legend

Hierarchy

Implements

Index

Properties

Methods

Accessors

Constructors

Properties

Protected isProviderBased

Private _animateOnDragInstance

Private _clickOutsideToClose

Private _clickedOutsideElement

Private _currentDirectionCssClass

Private _eventOverlayClick

Private _eventOverlayMouseDown

Private _eventSidebarKeypress

Private _focusManagerInstance

Private _focusTrapInstance

Private _gestureEventInstance

Private _hasGestureEvents

Private _isOpen

Private _parentSelf

Private _platformEventOnToggle

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 _closeSidebar

Memberof

Returns void

Private _handleFocusBehavior

Memberof

Returns void

Private _handleGestureEvents

Memberof

Returns void

Private _onGestureEnd

Memberof

Parameters

offsetX: number

offsetY: number

timeTaken: number

Returns void

Private _onGestureMove

Memberof

Parameters

x: number

y: number

offsetX: number

offsetY: number

evt: TouchEvent

Returns void

Private _onGestureStart

Memberof

Parameters

x: number

y: number

`Protected` isProviderBased

`Private` _animateOnDragInstance

`Private` _clickOutsideToClose

`Private` _clickedOutsideElement

`Private` _currentDirectionCssClass

`Private` _eventOverlayClick

`Private` _eventOverlayMouseDown

`Private` _eventSidebarKeypress

`Private` _focusManagerInstance

`Private` _focusTrapInstance

`Private` _gestureEventInstance

`Private` _hasGestureEvents

`Private` _isOpen

`Private` _parentSelf

`Private` _platformEventOnToggle

`Protected` finishBuild

`Protected` triggerPlatformEventCallback

`Rest` ...args: unknown[]

`Protected` triggerPlatformInitializedEventCallback

`Protected` unsetGlobalCallbacks

`Private` _closeSidebar

`Private` _handleFocusBehavior

`Private` _handleGestureEvents

`Private` _onGestureEnd

`Private` _onGestureMove

`Private` _onGestureStart

`Private` _openSidebar

`Private` _overlayClickCallback

`Private` _overlayMouseDownCallback

`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