LitElement

A simple base class for creating fast, lightweight web components.

LitElement is the base class that powers the Lit library for building fast web components.

Most users should import LitElement from the lit package rather than installing and importing from the lit-element package directly.

Documentation

Full documentation is available at lit.dev/docs/components/overview/.

Overview

LitElement is a base class for custom elements that extends the Lit project's core ReactiveElement (from `@lit/reactive-element') base class with lit-html templating. ReactiveElement enhances HTMLElement with reactive properties, additional lifecycle callbacks, convenient inline CSS authoring, and a set of useful class decorators, while lit-html provides fast, declarative HTML templating.

Example

1import {LitElement, html, css} from 'lit';
2import {customElement, property} from 'lit/decorators.js';
3
4// Registers the element
5@customElement('my-element')
6export class MyElement extends LitElement {
7  // Styles are applied to the shadow root and scoped to this element
8  static styles = css`
9    span {
10      color: green;
11    }
12  `;
13
14  // Creates a reactive property that triggers rendering
15  @property()
16  mood = 'great';
17
18  // Render the component's DOM by returning a Lit template
19  render() {
20    return html`Web Components are <span>${this.mood}</span>!`;
21  }
22}

Contributing

Please see CONTRIBUTING.md.