UNPKG

lit-element/README.md

Version:

1.76 kBMarkdownView Raw

1# LitElement 3.0
2
3A simple base class for creating fast, lightweight web components.
4
5[![Build Status](https://github.com/lit/lit/workflows/Tests/badge.svg)](https://github.com/lit/lit/actions?query=workflow%3ATests)
6[![Published on npm](https://img.shields.io/npm/v/lit-element.svg?logo=npm)](https://www.npmjs.com/package/lit-element)
7[![Join our Discord](https://img.shields.io/badge/discord-join%20chat-5865F2.svg?logo=discord&logoColor=fff)](https://lit.dev/discord/)
8[![Mentioned in Awesome Lit](https://awesome.re/mentioned-badge.svg)](https://github.com/web-padawan/awesome-lit)
9
10LitElement is the base class that powers the [Lit](https://lit.dev) library for building fast web components. Most users should import `LitElement` from the [`lit`](https://www.npmjs.com/package/lit) package rather than installing and importing from the `lit-element` package directly.
11
12## About this release
13
14This is a pre-release of Lit 3.0, the next major version of Lit.
15
16Lit 3.0 has very few breaking changes from Lit 2.0:
17
18- Drops support for IE11
19- Published as ES2021
20- Removes a couple of deprecated Lit 1.x APIs
21
22Lit 3.0 should require no changes to upgrade from Lit 2.0 for the vast majority of users. Once the full release is published, most apps and libraries will be able to extend their npm version ranges to include both 2.x and 3.x, like `"^2.7.0 || ^3.0.0"`.
23
24Lit 2.x and 3.0 are _interoperable_: templates, base classes, directives, decorators, etc., from one version of Lit will work with those from another.
25
26Please file any issues you find on our [issue tracker](https://github.com/lit/lit/issues).
27
28## Documentation
29
30Full documentation is available at [lit.dev](https://lit.dev).
31
32## Contributing
33
34Please see [CONTRIBUTING.md](../../CONTRIBUTING.md).

1	`# LitElement 3.0`
2
3	`A simple base class for creating fast, lightweight web components.`
4
5	`[![Build Status](https://github.com/lit/lit/workflows/Tests/badge.svg)](https://github.com/lit/lit/actions?query=workflow%3ATests)`
6	`[![Published on npm](https://img.shields.io/npm/v/lit-element.svg?logo=npm)](https://www.npmjs.com/package/lit-element)`
7	`[![Join our Discord](https://img.shields.io/badge/discord-join%20chat-5865F2.svg?logo=discord&logoColor=fff)](https://lit.dev/discord/)`
8	`[![Mentioned in Awesome Lit](https://awesome.re/mentioned-badge.svg)](https://github.com/web-padawan/awesome-lit)`
9
10	LitElement is the base class that powers the [Lit](https://lit.dev) library for building fast web components. Most users should import `LitElement` from the [`lit`](https://www.npmjs.com/package/lit) package rather than installing and importing from the `lit-element` package directly.
11
12	`## About this release`
13
14	`This is a pre-release of Lit 3.0, the next major version of Lit.`
15
16	`Lit 3.0 has very few breaking changes from Lit 2.0:`
17
18	`- Drops support for IE11`
19	`- Published as ES2021`
20	`- Removes a couple of deprecated Lit 1.x APIs`
21
22	Lit 3.0 should require no changes to upgrade from Lit 2.0 for the vast majority of users. Once the full release is published, most apps and libraries will be able to extend their npm version ranges to include both 2.x and 3.x, like `"^2.7.0 \|\| ^3.0.0"`.
23
24	`Lit 2.x and 3.0 are _interoperable_: templates, base classes, directives, decorators, etc., from one version of Lit will work with those from another.`
25
26	`Please file any issues you find on our [issue tracker](https://github.com/lit/lit/issues).`
27
28	`## Documentation`
29
30	`Full documentation is available at [lit.dev](https://lit.dev).`
31
32	`## Contributing`
33
34	`Please see [CONTRIBUTING.md](../../CONTRIBUTING.md).`