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

3.3.1 • Public • Published

lit-html

Efficient, Expressive, Extensible HTML templates in JavaScript

Build Status Published on npm Join our Discord Mentioned in Awesome Lit

lit-html is the template system that powers the Lit library for building fast web components.

When using lit-html to develop web components, most users should import lit-html via the lit package rather than installing and importing from lit-html directly.

Documentation

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

Overview

lit-html lets you write HTML templates in JavaScript with template literals.

lit-html templates are plain JavaScript and combine the familiarity of writing HTML with the power of JavaScript. lit-html takes care of efficiently rendering templates to DOM, including efficiently updating the DOM with new values.

import {html, render} from 'lit-html';

// This is a lit-html template function. It returns a lit-html template.
const helloTemplate = (name) => html`<div>Hello ${name}!</div>`;

// This renders <div>Hello Steve!</div> to the document body
render(helloTemplate('Steve'), document.body);

// This updates to <div>Hello Kevin!</div>, but only updates the ${name} part
render(helloTemplate('Kevin'), document.body);

lit-html provides two main exports:

  • html: A JavaScript template tag used to produce a TemplateResult, which is a container for a template, and the values that should populate the template.
  • render(): A function that renders a TemplateResult to a DOM container, such as an element or shadow root.

Installation

$ npm install lit-html

Or use from lit:

$ npm install lit

Contributing

Please see CONTRIBUTING.md.

/lit-html/

    Package Sidebar

    Install

    npm i lit-html

    Homepage

    lit.dev/

    Weekly Downloads

    3,402,413

    Version

    3.3.1

    License

    BSD-3-Clause

    Unpacked Size

    1.71 MB

    Total Files

    363

    Last publish

    Collaborators

    • aomarks
    • emarquez
    • sorvell
    • bicknellr
    • usergenic
    • polymer-devs
    • azakus
    • kevinpschaaf
    • justinfagnani
    • rictic
    • graynorton
    • lit-robot
    • augustjk