Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

Index

Constructors

constructor

Properties

amplification

amplification: number = 1

closable

closable: boolean = false

exclusive

exclusive: boolean = false

imageScaleFactor

imageScaleFactor: number = 0.5

inputElement

inputElement: AbstractInputElement

inputSelector

inputSelector: string = "acc-pose-input"

open

open: boolean = false

part

part: string

parts

parts: string[] = []

priority

priority: number = 0

renderComplete

renderComplete: Promise<boolean>

Returns a promise which resolves after the element next renders. The promise resolves to true if the element rendered and false if the element did not render. This is useful when users (e.g. tests) need to react to the rendered state of the element after a change is made. This can also be useful in event handlers if it is desireable to wait to send an event until after rendering. If possible implement the _didRender method to directly respond to rendering within the rendering lifecycle.

smoothing

smoothing: number = 0

Static Protected _openModals

_openModals: AbstractModalElement[] = []

Methods

Protected _applyRender

  • _applyRender(result: TemplateResult, node: Element | DocumentFragment): void
  • Renders the given lit-html template result into the given node. Implement to customize the way rendering is applied. This is should not typically be needed and is provided for advanced use cases.

    Parameters

    • result: TemplateResult

      lit-html template result to render

    • node: Element | DocumentFragment

      node into which to render

    Returns void

Protected _close

  • _close(): void
  • close the modal, called internally via _propertiesChanged as the result of the open property changing

    Returns void

Protected _createRoot

  • _createRoot(): Element | DocumentFragment
  • Implement to customize where the element's template is rendered by returning an element into which to render. By default this creates a shadowRoot for the element. To render into the element's childNodes, return this.

    Returns Element | DocumentFragment

    Returns a node into which to render.

_didRender

  • _didRender(props: any, changed: any, prev: any): void
  • Parameters

    • props: any
    • changed: any
    • prev: any

    Returns void

_firstRendered

  • _firstRendered(): void
  • Returns void

_flushProperties

  • _flushProperties(): void
  • Returns void

Protected _handleCloseClick

  • _handleCloseClick(): void

_invalidateProperties

  • _invalidateProperties(): void
  • Override which provides tracking of invalidated state.

    Returns void

_onTick

  • Parameters

    Returns void

Protected _open

  • _open(): void
  • close the modal, called internally via _propertiesChanged as the result of the open property changing

    Returns void

_propertiesChanged

  • _propertiesChanged(props: any, changed: any, prev: any): void

_render

  • _render(props: any): TemplateResult
  • Parameters

    • props: any

    Returns TemplateResult

_renderModalBody

  • _renderModalBody(props: any): TemplateResult

_shouldPropertiesChange

  • _shouldPropertiesChange(_props: object, _changedProps: object, _prevProps: object): boolean
  • Override which returns the value of _shouldRender which users should implement to control rendering. If this method returns false, _propertiesChanged will not be called and no rendering will occur even if property values change or requestRender is called.

    Parameters

    • _props: object

      Current element properties

    • _changedProps: object

      Changing element properties

    • _prevProps: object

      Previous element properties

    Returns boolean

    Default implementation always returns true.

_shouldPropertyChange

  • _shouldPropertyChange(property: string, value: any, old: any): boolean
  • Override which warns when a user attempts to change a property during the rendering lifecycle. This is an anti-pattern and should be avoided.

    Parameters

    • property: string
    • value: any
    • old: any

    Returns boolean

_shouldRender

  • _shouldRender(props: any, changed: any, prev: any): boolean
  • Parameters

    • props: any
    • changed: any
    • prev: any

    Returns boolean

connectedCallback

  • connectedCallback(): void
  • Returns void

focus

  • focus(): void

focusHeader

  • focusHeader(): void
  • Returns void

ready

  • ready(): void
  • Override which sets up element rendering by calling* _createRoot and _firstRendered.

    Returns void

requestRender

  • requestRender(): void
  • Call to request the element to asynchronously re-render regardless of whether or not any property changes are pending.

    Returns void

Static Protected _findHideableElements

Static Protected _showOnTop

  • _showOnTop(): void