Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface DropDownComponent

Hierarchy

Index

Properties

Methods

Properties

Optional CSSStyles

CSSStyles: CssStyles

Matches the CSS style key and its available values.

Optional ariaHidden

ariaHidden: boolean

Corresponds to the aria-hidden accessibility attribute for this component

Optional ariaLabel

ariaLabel: string

Corresponds to the aria-label accessibility attribute for this component

Optional ariaRole

ariaRole: string

Corresponds to the role accessibility attribute for this component

Optional ariaSelected

ariaSelected: boolean

Corresponds to the aria-selected accessibility attribute for this component

Optional display

display: DisplayType

Corresponds to the display CSS property for the element

Optional editable

editable: boolean

Optional enabled

enabled: boolean

Whether the component is enabled in the DOM

Optional fireOnTextChange

fireOnTextChange: boolean

Optional height

height: string | number

Readonly id

id: string

Optional loading

loading: boolean

Whether to show the loading spinner instead of the contained component. True by default

Optional loadingCompletedText

loadingCompletedText: string

The text to display while loading is set to false. Will also be announced through screen readers once loading is completed.

Optional loadingText

loadingText: string

The text to display while loading is set to true

Readonly onValidityChanged

onValidityChanged: Event<boolean>

Event fired to notify that the component's validity has changed

onValueChanged

onValueChanged: Event<any>

Optional position

position: PositionType

The position CSS property. Empty by default. This is particularly useful if laying out components inside a FlexContainer and the size of the component is meant to be a fixed size. In this case the position must be set to 'absolute', with the parent FlexContainer having 'relative' position. Without this the component will fail to correctly size itself

Optional required

required: boolean

Optional showText

showText: boolean

Whether to show the loading text next to the spinner

Readonly valid

valid: boolean

Whether the component is valid or not

Optional value

value: string | CategoryValue

Optional values

values: CategoryValue[] | string[]

Optional width

width: string | number

Methods

focus

  • focus(): Thenable<void>

  • Focuses the component.

    Returns Thenable<void>

updateCssStyles

  • updateCssStyles(cssStyles: CssStyles): Thenable<void>

  • Updates the specified CSS Styles and notifies the UI

    Parameters

    Returns Thenable<void>

    Thenable that completes once the update has been applied to the UI

updateProperties

  • updateProperties(properties: {}): Thenable<void>

  • Sends any updated properties of the component to the UI

    Parameters

    • properties: {}
      • [key: string]: any

    Returns Thenable<void>

    Thenable that completes once the update has been applied in the UI

updateProperty

  • updateProperty(key: string, value: any): Thenable<void>

  • Sends an updated property of the component to the UI

    Parameters

    • key: string
    • value: any

    Returns Thenable<void>

    Thenable that completes once the update has been applied in the UI

validate

  • validate(): Thenable<boolean>

  • Run the component's validations

    Returns Thenable<boolean>

Generated using TypeDoc