Wondering what’s next for npm?Check out our public roadmap! »

lit-element
TypeScript icon, indicating that this package has built-in type declarations

2.4.0 • Public • Published

LitElement

A simple base class for creating fast, lightweight web components with lit-html.

Build Status Published on npm Join our Slack Published on webcomponents.org Mentioned in Awesome lit-html

Documentation

Full documentation is available at lit-element.polymer-project.org.

Overview

LitElement uses lit-html to render into the element's Shadow DOM and adds API to help manage element properties and attributes. LitElement reacts to changes in properties and renders declaratively using lit-html. See the lit-html guide for additional information on how to create templates for lit-element.

    import {LitElement, html, css, customElement, property} from 'lit-element';
 
    // This decorator defines the element.
    @customElement('my-element')
    export class MyElement extends LitElement {
 
      // This decorator creates a property accessor that triggers rendering and
      // an observed attribute.
      @property()
      mood = 'great';
 
      static styles = css`
        span {
          color: green;
        }`;
 
      // Render element DOM by returning a `lit-html` template.
      render() {
        return html`Web Components are <span>${this.mood}</span>!`;
      }
 
    }
    <my-element mood="awesome"></my-element>

Note, this example uses decorators to create properties. Decorators are a proposed standard currently available in TypeScript or Babel. LitElement also supports a vanilla JavaScript method of declaring reactive properties.

Examples

Installation

From inside your project folder, run:

$ npm install lit-element

To install the web components polyfills needed for older browsers:

$ npm i -D @webcomponents/webcomponentsjs

Supported Browsers

The last 2 versions of all modern browsers are supported, including Chrome, Safari, Opera, Firefox, Edge. In addition, Internet Explorer 11 is also supported.

Edge and Internet Explorer 11 require the web components polyfills.

Contributing

Please see CONTRIBUTING.md.

Keywords

none

Install

npm i lit-element

DownloadsWeekly Downloads

155,639

Version

2.4.0

License

BSD-3-Clause

Unpacked Size

318 kB

Total Files

39

Last publish

Collaborators

  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar