Class AccordionItem

Defines the interface for OutSystemsUI Patterns

Hierarchy-Diagram

Legend

class

abstract class

interface

public property

protected property

private property

public method

protected method

private method

italic abstract property/method

Hierarchy

OSFramework.OSUI.Patterns.AbstractChild<AccordionItemConfig, IAccordion>
- AccordionItem

Implements

IAccordionItem

Index

Methods

`Protected` notifyParent

notifyParent(actionType: string): void
Method used to notify parent about the action that was performed

Memberof
OSFramework.Patterns.AbstractChild
Parameters
- actionType: string
  
  Action Type name (Should be based on an Enum)
Returns void
Inherited from AbstractChild.notifyParent
- Defined in OSFramework/OSUI/Pattern/AbstractChild.ts:36

`Protected` setParentInfo

setParentInfo(parentSelector: string, getPatternByIdAPI: Function, canBeOrphan?: boolean): void
Protected
Method that will Get and Set parent element info.

Memberof
OSFramework.Patterns.AbstractChild
Parameters
- parentSelector: string
  
  Selector to find for parent Element
- getPatternByIdAPI: Function
  
  API reference method from Parent Pattern that will return the PatternById
- Optional canBeOrphan: boolean
  
  option for patterns that can work without a parent
Returns void
Inherited from AbstractChild.setParentInfo
- Defined in OSFramework/OSUI/Pattern/AbstractChild.ts:50

`Protected` finishBuild

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

Memberof
OSFramework.Patterns.AbstractPattern

Returns void
Inherited from AbstractChild.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 AbstractChild.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 AbstractChild.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 AbstractChild.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 IAccordionItem.equalsToID

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

`Private` _accordionOnClickHandler

_accordionOnClickHandler(event: MouseEvent): void
Private
Method to handle the click event

Returns
{void}

Memberof
AccordionItem
Parameters
- event: MouseEvent
Returns void
- Defined in OSFramework/OSUI/Pattern/AccordionItem/AccordionItem.ts:94

`Private` _addEvents

_addEvents(): void
Private
Method to add the event listeners

Memberof
AccordionItem

Returns void
- Defined in OSFramework/OSUI/Pattern/AccordionItem/AccordionItem.ts:118

`Private` _animationAsync

_animationAsync(isExpand: boolean): void
Private
Method to handle async animation

Memberof
AccordionItem
Parameters
- isExpand: boolean
Returns void
- Defined in OSFramework/OSUI/Pattern/AccordionItem/AccordionItem.ts:132

`Private` _changeClikableTargetArea

_changeClikableTargetArea(): void
Private
Method that toogles the clickable area between the whole title (default) and the icon.

Memberof
AccordionItem

Returns void
- Defined in OSFramework/OSUI/Pattern/AccordionItem/AccordionItem.ts:173

`Private` _handleTabIndex

_handleTabIndex(): void
Private
Method to handle the tabindex values

Memberof
AccordionItem

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

`Private` _onKeyboardPress

_onKeyboardPress(event: KeyboardEvent): void
Private
Method to handle Keyboardpress event

Returns
{void}

Memberof
AccordionItem
Parameters
- event: KeyboardEvent
Returns void
- Defined in OSFramework/OSUI/Pattern/AccordionItem/AccordionItem.ts:216

`Private` _onToggleCallback

_onToggleCallback(): void
Private
Method to handle the keyboard interactions

Memberof
AccordionItem

Returns void
- Defined in OSFramework/OSUI/Pattern/AccordionItem/AccordionItem.ts:243

`Private` _removeA11Properties

_removeA11Properties(): void
Returns void
- Defined in OSFramework/OSUI/Pattern/AccordionItem/AccordionItem.ts:247

`Private` _removeEvents

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

Memberof
AccordionItem

Returns void
- Defined in OSFramework/OSUI/Pattern/AccordionItem/AccordionItem.ts:260

`Private` _setA11ToogleElement

_setA11ToogleElement(): void
Returns void
- Defined in OSFramework/OSUI/Pattern/AccordionItem/AccordionItem.ts:266

`Private` _setAccordionParent

_setAccordionParent(): void
Private
Method to set the parent Info, if an accordion wrapper is being used

Memberof
AccordionItem

Returns void
- Defined in OSFramework/OSUI/Pattern/AccordionItem/AccordionItem.ts:282

`Private` _setIconPosition

_setIconPosition(): void
Private
Method that changes the icon's position

Memberof
AccordionItem

Returns void
- Defined in OSFramework/OSUI/Pattern/AccordionItem/AccordionItem.ts:302

`Private` _setIconType

_setIconType(): void
Private
Method that changes the icon's type (Caret, Plus/Minus, Custom)

Memberof
AccordionItem

Returns void
- Defined in OSFramework/OSUI/Pattern/AccordionItem/AccordionItem.ts:319

`Private` _setIsDisabledState

_setIsDisabledState(): void
Private
Method to handle the IsDisabled state

Memberof
AccordionItem

Returns void
- Defined in OSFramework/OSUI/Pattern/AccordionItem/AccordionItem.ts:351

`Private` _transitionEndHandler

_transitionEndHandler(): void
Private
Method to handle the onTransitionEnd on accordion toggle animation

Memberof
AccordionItem

Returns void
- Defined in OSFramework/OSUI/Pattern/AccordionItem/AccordionItem.ts:382

`Protected` setA11YProperties

setA11YProperties(): void
Protected
Method to handle Accessibility attributes

Memberof
OSFramework.Patterns.AccordionItem.AccordionItem

Returns void
Overrides AbstractChild.setA11YProperties
- Defined in OSFramework/OSUI/Pattern/AccordionItem/AccordionItem.ts:411

`Protected` setCallbacks

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

Memberof
OSFramework.Patterns.AccordionItem.AccordionItem

Returns void
Overrides AbstractChild.setCallbacks
- Defined in OSFramework/OSUI/Pattern/AccordionItem/AccordionItem.ts:452

`Protected` setHtmlElements

setHtmlElements(): void
Protected
Method to set the HTML elements of the Accordion Item

Memberof
OSFramework.Patterns.AccordionItem.AccordionItem

Returns void
Overrides AbstractChild.setHtmlElements
- Defined in OSFramework/OSUI/Pattern/AccordionItem/AccordionItem.ts:464

`Protected` setInitialCssClasses

setInitialCssClasses(): void
Protected
Method to set the initial CSS Classes

Memberof
OSFramework.Patterns.AccordionItem.AccordionItem

Returns void
- Defined in OSFramework/OSUI/Pattern/AccordionItem/AccordionItem.ts:488

`Protected` unsetCallbacks

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

Memberof
OSFramework.Patterns.AccordionItem.AccordionItem

Returns void
Overrides AbstractChild.unsetCallbacks
- Defined in OSFramework/OSUI/Pattern/AccordionItem/AccordionItem.ts:511

`Protected` unsetHtmlElements

unsetHtmlElements(): void
Protected
Method to unset the html elements

Memberof
OSFramework.Patterns.AccordionItem.AccordionItem

Returns void
Overrides AbstractChild.unsetHtmlElements
- Defined in OSFramework/OSUI/Pattern/AccordionItem/AccordionItem.ts:523

allowTitleEvents

allowTitleEvents(): void
Method to prevent clicks inside thte title to open the accordion

Memberof
OSFramework.Patterns.AccordionItem.AccordionItem

Returns void
Implementation of IAccordionItem.allowTitleEvents
- Defined in OSFramework/OSUI/Pattern/AccordionItem/AccordionItem.ts:558

build

build(): void
Method to build the AccordionItem

Memberof
OSFramework.Patterns.AccordionItem.AccordionItem

Returns void
Implementation of IAccordionItem.build

Overrides AbstractChild.build
- Defined in OSFramework/OSUI/Pattern/AccordionItem/AccordionItem.ts:567

changeProperty

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

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

Overrides AbstractChild.changeProperty
- Defined in OSFramework/OSUI/Pattern/AccordionItem/AccordionItem.ts:588

close

close(): void
Method to close the AccordionItem

Memberof
OSFramework.Patterns.AccordionItem.AccordionItem

Returns void
Implementation of IAccordionItem.close
- Defined in OSFramework/OSUI/Pattern/AccordionItem/AccordionItem.ts:619

dispose

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

Memberof
OSFramework.Patterns.AccordionItem.AccordionItem

Returns void
Implementation of IAccordionItem.dispose

Overrides AbstractChild.dispose
- Defined in OSFramework/OSUI/Pattern/AccordionItem/AccordionItem.ts:649

open

open(): void
Method to open the AccordionItem

Memberof
OSFramework.Patterns.AccordionItem.AccordionItem

Returns void
Implementation of IAccordionItem.open
- Defined in OSFramework/OSUI/Pattern/AccordionItem/AccordionItem.ts:668

registerCallback

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

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

Overrides AbstractChild.registerCallback
- Defined in OSFramework/OSUI/Pattern/AccordionItem/AccordionItem.ts:715

Accessors

isFirstChild

get isFirstChild(): boolean
Getter that allows to check if it's the first child.

Memberof
OSFramework.Patterns.AbstractChild

Returns boolean
Implementation of IAccordionItem.isFirstChild

Inherited from AbstractChild.isFirstChild
- Defined in OSFramework/OSUI/Pattern/AbstractChild.ts:77

isLastChild

get isLastChild(): boolean
Getter that allows to check if it's the last child.

Memberof
OSFramework.Patterns.AbstractChild

Returns boolean
Implementation of IAccordionItem.isLastChild

Inherited from AbstractChild.isLastChild
- Defined in OSFramework/OSUI/Pattern/AbstractChild.ts:97
set isLastChild(value: boolean): void
Setter that allows to define it's the last child.

Memberof
OSFramework.Patterns.AbstractChild
Parameters
- value: boolean
Returns void
Implementation of IAccordionItem.isLastChild

Inherited from AbstractChild.isLastChild
- Defined in OSFramework/OSUI/Pattern/AbstractChild.ts:106

parentId

get parentId(): string
Getter that allows to obtain the parentId.

Memberof
OSFramework.Patterns.AbstractChild

Returns string
Inherited from AbstractChild.parentId
- Defined in OSFramework/OSUI/Pattern/AbstractChild.ts:117

parentObject

get parentObject(): PT
Getter that allows to obtain the parent reference.

Memberof
OSFramework.Patterns.AbstractChild

Returns PT
Inherited from AbstractChild.parentObject
- Defined in OSFramework/OSUI/Pattern/AbstractChild.ts:128

`Protected` _enableAccessibility

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

Memberof
OSFramework.Patterns.AbstractPattern

Returns boolean
Inherited from AbstractChild._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 IAccordionItem.selfElement

Inherited from AbstractChild.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 IAccordionItem.isBuilt

Inherited from AbstractChild.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 AbstractChild.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 IAccordionItem.uniqueId

Inherited from AbstractChild.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 IAccordionItem.widgetId

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

`Private` _elementWithEvents

get _elementWithEvents(): HTMLElement
Private
Getter that obtains the element that should be the clicking place to toggle the accordion.

Memberof
AccordionItem

Returns HTMLElement
- Defined in OSFramework/OSUI/Pattern/AccordionItem/AccordionItem.ts:53

`Private` _previousElementWithEvents

get _previousElementWithEvents(): HTMLElement
Private
Getter that obtains the previous element that was the clicking place. Useful to remove events and A11Y attributes.

Memberof
AccordionItem

Returns HTMLElement
- Defined in OSFramework/OSUI/Pattern/AccordionItem/AccordionItem.ts:74

isDisabled

get isDisabled(): boolean
Method to return the isDisabled value

Memberof
OSFramework.Patterns.AccordionItem.AccordionItem

Returns boolean
Implementation of IAccordionItem.isDisabled
- Defined in OSFramework/OSUI/Pattern/AccordionItem/AccordionItem.ts:538

isOpen

get isOpen(): boolean
Method to return the IsOpen value

Memberof
OSFramework.Patterns.AccordionItem.AccordionItem

Returns boolean
Implementation of IAccordionItem.isOpen
- Defined in OSFramework/OSUI/Pattern/AccordionItem/AccordionItem.ts:549

Properties

`Protected` isProviderBased

isProviderBased: boolean = false

`Private` _accordionItemContentElem

_accordionItemContentElem: HTMLElement

`Private` _accordionItemIconCustomElem

_accordionItemIconCustomElem: HTMLElement

`Private` _accordionItemIconElem

_accordionItemIconElem: HTMLElement

`Private` _accordionItemPlaceholder

_accordionItemPlaceholder: HTMLElement

`Private` _accordionItemTitleElem

_accordionItemTitleElem: HTMLElement

`Private` _accordionTitleFocusableChildren

_accordionTitleFocusableChildren: HTMLElement[]

`Private` _allowTitleEvents

_allowTitleEvents: boolean

`Private` _collapsedHeight

_collapsedHeight: number = 0

`Private` _eventOnClick

_eventOnClick: Generic

`Private` _eventOnTransitionEnd

_eventOnTransitionEnd: Generic

`Private` _eventOnkeyPress

_eventOnkeyPress: Generic

`Private` _expandedHeight

_expandedHeight: number

`Private` _isOpen

_isOpen: boolean

`Private` _platformEventOnToggle

_platformEventOnToggle: Generic

Constructors

constructor

new AccordionItem(uniqueId: string, configs: JSON): OSFramework.OSUI.Patterns.AccordionItem.AccordionItem
Parameters
- uniqueId: string
- configs: JSON
Returns OSFramework.OSUI.Patterns.AccordionItem.AccordionItem
Overrides AbstractChild.constructor
- Defined in OSFramework/OSUI/Pattern/AccordionItem/AccordionItem.ts:39

Class AccordionItem

Hierarchy-Diagram

Legend

Hierarchy

Implements

Index

Methods

Accessors

Properties

Constructors

Methods

Protected notifyParent

Memberof

Parameters

actionType: string

Returns void

Protected setParentInfo

Memberof

Parameters

parentSelector: string

getPatternByIdAPI: Function

Optional canBeOrphan: boolean

Returns void

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 _accordionOnClickHandler

Returns

Memberof

Parameters

event: MouseEvent

Returns void

Private _addEvents

Memberof

Returns void

Private _animationAsync

Memberof

Parameters

isExpand: boolean

Returns void

Private _changeClikableTargetArea

Memberof

Returns void

Private _handleTabIndex

Memberof

Returns void

Private _onKeyboardPress

Returns

Memberof

Parameters

event: KeyboardEvent

Returns void

Private _onToggleCallback

Memberof

Returns void

Private _removeA11Properties

Returns void

Private _removeEvents

Memberof

Returns void

Private _setA11ToogleElement

Returns void

`Protected` notifyParent

`Protected` setParentInfo

`Optional` canBeOrphan: boolean

`Protected` finishBuild

`Protected` triggerPlatformEventCallback

`Rest` ...args: unknown[]

`Protected` triggerPlatformInitializedEventCallback

`Protected` unsetGlobalCallbacks

`Private` _accordionOnClickHandler

`Private` _addEvents

`Private` _animationAsync

`Private` _changeClikableTargetArea

`Private` _handleTabIndex

`Private` _onKeyboardPress

`Private` _onToggleCallback

`Private` _removeA11Properties

`Private` _removeEvents

`Private` _setA11ToogleElement

`Private` _setAccordionParent

`Private` _setIconPosition

`Private` _setIconType

`Private` _setIsDisabledState

`Private` _transitionEndHandler

`Protected` setA11YProperties

`Protected` setCallbacks

`Protected` setHtmlElements

`Protected` setInitialCssClasses

`Protected` unsetCallbacks

`Protected` unsetHtmlElements