Options
All
  • Public
  • Public/Protected
  • All
Menu

Class LitElement

Hierarchy

Index

Constructors

constructor

Properties

Protected Optional renderRoot

renderRoot: Element | DocumentFragment

Node or ShadowRoot into which element DOM should be rendered. Defaults to an open shadowRoot.

Static Protected finalized

finalized: boolean = true

Ensure this class is marked as finalized as an optimization ensuring it will not needlessly try to finalize.

Static properties

User-supplied object that maps property names to PropertyDeclaration objects containing options for configuring the property.

Static render

render: render = render

Render method used to render the lit-html TemplateResult to the element's DOM.

param

to render.

param

into which to render.

param

name.

nocollapse

Static Optional styles

Array of styles to apply to the element. The styles should be defined using the css tag function.

Accessors

Protected hasUpdated

  • get hasUpdated(): number

updateComplete

  • get updateComplete(): Promise<unknown>
  • Returns a Promise that resolves when the element has completed updating. The Promise value is a boolean that is true if the element completed the update without triggering another update. The Promise result is false if a property was set inside updated(). This getter can be implemented to await additional state. For example, it is sometimes useful to await a rendered element before fulfilling this Promise. To do this, first await super.updateComplete then any subsequent state.

    Returns Promise<unknown>

    The Promise returns a boolean that indicates if the update resolved without triggering another update.

Static observedAttributes

  • get observedAttributes(): string[]

Methods

Protected adoptStyles

  • adoptStyles(): void
  • Applies styling to the element shadowRoot using the static get styles property. Styling will apply using shadowRoot.adoptedStyleSheets where available and will fallback otherwise. When Shadow DOM is polyfilled, ShadyCSS scopes styles and adds them to the document. When Shadow DOM is available but adoptedStyleSheets is not, styles are appended to the end of the shadowRoot to mimic spec behavior.

    Returns void

attributeChangedCallback

  • attributeChangedCallback(name: string, old: string, value: string): void

connectedCallback

  • connectedCallback(): void

Protected createRenderRoot

  • createRenderRoot(): Element | ShadowRoot
  • Returns the node into which the element should render and by default creates and returns an open shadowRoot. Implement to customize where the element's DOM is rendered. For example, to render into the element's childNodes, return this.

    Returns Element | ShadowRoot

    Returns a node into which to render.

disconnectedCallback

  • disconnectedCallback(): void

Protected firstUpdated

  • Invoked when the element is first updated. Implement to perform one time work on the element after update.

    Setting properties inside this method will trigger the element to update again after this update cycle completes.

    • @param _changedProperties Map of changed properties with old values

    Parameters

    Returns void

Protected initialize

  • initialize(): void
  • Performs element initialization. By default this calls createRenderRoot to create the element renderRoot node and captures any pre-set values for registered properties.

    Returns void

Protected performUpdate

  • performUpdate(): void | Promise<unknown>
  • Performs an element update.

    You can override this method to change the timing of updates. For instance, to schedule updates to occur just before the next frame:

    protected async performUpdate(): Promise<unknown> {
      await new Promise((resolve) => requestAnimationFrame(() => resolve()));
      super.performUpdate();
    }

    Returns void | Promise<unknown>

Protected render

  • render(): TemplateResult | void
  • Invoked on each update to perform rendering tasks. This method must return a lit-html TemplateResult. Setting properties inside this method will not trigger the element to update.

    Returns TemplateResult | void

requestUpdate

  • requestUpdate(name?: PropertyKey, oldValue?: any): Promise<unknown>
  • Requests an update which is processed asynchronously. This should be called when an element should update based on some state not triggered by setting a property. In this case, pass no arguments. It should also be called when manually implementing a property setter. In this case, pass the property name and oldValue to ensure that any configured property options are honored. Returns the updateComplete Promise which is resolved when the update completes.

    Parameters

    • Optional name: PropertyKey

      (optional) name of requesting property

    • Optional oldValue: any

      (optional) old value of requesting property

    Returns Promise<unknown>

    A Promise that is resolved when the update completes.

Protected shouldUpdate

  • Controls whether or not update should be called when the element requests an update. By default, this method always returns true, but this can be customized to control when to update.

    • @param _changedProperties Map of changed properties with old values

    Parameters

    Returns boolean

Protected update

  • Updates the element. This method reflects property values to attributes and calls render to render DOM via lit-html. Setting properties inside this method will not trigger another update.

    • @param _changedProperties Map of changed properties with old values

    Parameters

    Returns void

Protected updated

  • Invoked whenever the element is updated. Implement to perform post-updating tasks via DOM APIs, for example, focusing an element.

    Setting properties inside this method will trigger the element to update again after this update cycle completes.

    • @param _changedProperties Map of changed properties with old values

    Parameters

    Returns void

Static createProperty

  • Creates a property accessor on the element prototype if one does not exist. The property setter calls the property's hasChanged property option or uses a strict identity check to determine whether or not to request an update.

    nocollapse

    Parameters

    Returns void

Static Protected finalize

  • finalize(): void

Generated using TypeDoc