UNPKG

11.9 kBMarkdownView Raw
1# Change Log
2
3All notable changes to this project will be documented in this file.
4
5The format is based on [Keep a Changelog](http://keepachangelog.com/)
6and this project adheres to [Semantic Versioning](http://semver.org/).
7
8<!--
9 PRs should document their user-visible changes (if any) in the
10 Unreleased section, uncommenting the header as necessary.
11-->
12
13<!-- ## Unreleased -->
14<!-- ### Added -->
15<!-- ### Removed -->
16<!-- ### Fixed -->
17<!-- ### Changed -->
18
19## [2.2.1] - 2019-07-23
20### Changed
21* Elements should now override the new `_getUpdateComplete` method instead of the `updateComplete` getter, for compatibility with TypeScript ES5 output, which does not support calling a superclass getter (e.g.`super.updateComplete.then(...)`) due to [TypeScript#338](https://github.com/microsoft/TypeScript/issues/338).
22### Fixed
23* Fixed compatibility with Closure JS Compiler optimizations relating to static properties ([#732](https://github.com/Polymer/lit-element/issues/732)).
24
25## [2.2.0] - 2019-06-11
26### Added
27* css tagged template literals now allow numbers to be used in expressions ([#488](https://github.com/Polymer/lit-element/issues/488)).
28
29## [2.1.0] - 2019-03-21
30### Changed
31* `LitElement.renderRoot` is now `public readonly` instead of `protected`.
32
33### Fixed
34* Exceptions generated during update/render do not block subsequent updates ([#262](https://github.com/Polymer/lit-element/issues/262)).
35* Initial update is scheduled at construction time rather than connected time ([#594](https://github.com/Polymer/lit-element/issues/594)).
36* A reflecting property set immediately after a corresponding attribute
37now reflects properly ([#592](https://github.com/Polymer/lit-element/issues/592)).
38* Properties annotated with the `@query` and `@queryAll` decorators will now
39 survive property renaming optimizations when used with tsickle and Closure JS
40 Compiler.
41
42## [2.0.1] - 2019-02-05
43### Fixed
44* Use `lit-html` 1.0 ([#543](https://github.com/Polymer/lit-element/pull/543)).
45
46## [2.0.0] - 2019-02-05
47### Added
48* Add `toString()` function to `CSSResult` ([#508](https://github.com/Polymer/lit-element/pull/508))
49* Add a global version to `window` ([#536](https://github.com/Polymer/lit-element/pull/536))
50
51### Changed
52* [Breaking] Renamed `unsafeCss` to `unsafeCSS` for consistency with lit-html's `unsafeHTML` ([#524](https://github.com/Polymer/lit-element/pull/524))
53* Remove all uses of `any` outside of tests ([#457](https://github.com/Polymer/lit-element/pull/457))
54
55### Fixed
56* A bunch of docs fixes ([#464](https://github.com/Polymer/lit-element/pull/464)), ([#458](https://github.com/Polymer/lit-element/pull/458)), ([#493](https://github.com/Polymer/lit-element/pull/493)), ([#504](https://github.com/Polymer/lit-element/pull/504)), ([#505](https://github.com/Polymer/lit-element/pull/505)), ([#501](https://github.com/Polymer/lit-element/pull/501)), ([#494](https://github.com/Polymer/lit-element/pull/494)), ([#491](https://github.com/Polymer/lit-element/pull/491)), ([#509](https://github.com/Polymer/lit-element/pull/509)), ([#513](https://github.com/Polymer/lit-element/pull/513)), ([#515](https://github.com/Polymer/lit-element/pull/515)), ([#512](https://github.com/Polymer/lit-element/pull/512)), ([#503](https://github.com/Polymer/lit-element/pull/503)), ([#460](https://github.com/Polymer/lit-element/pull/460)), ([#413](https://github.com/Polymer/lit-element/pull/413)), ([#426](https://github.com/Polymer/lit-element/pull/426)), ([#516](https://github.com/Polymer/lit-element/pull/516)), ([#537](https://github.com/Polymer/lit-element/pull/537)), ([#535](https://github.com/Polymer/lit-element/pull/535)), ([#539](https://github.com/Polymer/lit-element/pull/539)), ([#540](https://github.com/Polymer/lit-element/pull/540))
57* Build on checkout ([#423](https://github.com/Polymer/lit-element/pull/423))
58
59### Fixed
60* Adds a check to ensure `CSSStyleSheet` is constructable ([#527](https://github.com/Polymer/lit-element/pull/527)).
61
62## [2.0.0-rc.5] - 2019-01-24
63### Fixed
64* Fixed a bug causing duplicate styles when an array was returned from `static get styles` ([#480](https://github.com/Polymer/lit-element/issues/480)).
65
66## [2.0.0-rc.4] - 2019-01-24
67### Added
68* [Maintenance] Added script to publish dev releases automatically ([#476](https://github.com/Polymer/lit-element/pull/476)).
69* Adds `unsafeCss` for composing "unsafe" values into `css`. Note, `CSSResult` is no longer constructable. ([#451](https://github.com/Polymer/lit-element/issues/451) and [#471](https://github.com/Polymer/lit-element/issues/471)).
70
71### Fixed
72* Fixed a bug where we broke compatibility with closure compiler's property renaming optimizations. JSCompiler_renameProperty can't be a module export ([#465](https://github.com/Polymer/lit-element/pull/465)).
73* Fixed an issue with inheriting from `styles` property when extending a superclass that is never instanced. ([#470](https://github.com/Polymer/lit-element/pull/470)).
74* Fixed an issue with Closure Compiler and ([#470](https://github.com/Polymer/lit-element/pull/470)) ([#476](https://github.com/Polymer/lit-element/pull/476)).
75
76## [2.0.0-rc.3] - 2019-01-18
77### Fixed
78* README: Fixed jsfiddle reference ([#435](https://github.com/Polymer/lit-element/pull/435)).
79* Compile with Closure Compiler cleanly ([#436](https://github.com/Polymer/lit-element/pull/436)).
80* Opt `@property` decorators out of Closure Compiler renaming ([#448](https://github.com/Polymer/lit-element/pull/448)).
81
82### Changed
83* [Breaking] Property accessors are no longer wrapped when they already exist. Instead the `noAccessor` flag should be set when a user-defined accessor exists on the prototype (and in this case, user-defined accessors must call `requestUpdate` themselves). ([#454](https://github.com/Polymer/lit-element/pull/454)).
84* Class fields can now be used to define styles, e.g. `static styles = css` and `styles` correctly compose when elements are extended ([#456](https://github.com/Polymer/lit-element/pull/456)).
85* Styles returned via `static styles` are automatically flattend ([#437](https://github.com/Polymer/lit-element/pull/437)).
86* Replace use of for/of loops over Maps with forEach ([#455](https://github.com/Polymer/lit-element/pull/455))
87
88## [2.0.0-rc.2] - 2019-01-11
89### Fixed
90* Fix references to `@polymer/lit-element` in README and docs ([#427](https://github.com/Polymer/lit-element/pull/427)).
91* Fix decorator types causing compiler errors for TypeScript users. ([#431](https://github.com/Polymer/lit-element/pull/431)).
92
93## [2.0.0-rc.1] - 2019-01-10
94### Changed
95* [Breaking] Changed NPM package name to `lit-element`
96
97## [0.7.0] - 2019-01-10
98### Added
99* Updated decorator implementations to support TC39 decorator API proposal (supported by Babel 7.1+) in addition to the legacy decorator API (supported by older Babel and TypeScript) ([#156](https://github.com/Polymer/lit-element/issues/156)).
100* Added `static get styles()` to allow defining element styling separate from `render` method.
101This takes advantage of [`adoptedStyleSheets`](https://wicg.github.io/construct-stylesheets/#using-constructed-stylesheets) when possible ([#391](https://github.com/Polymer/lit-element/issues/391)).
102* Added the `performUpdate` method to allow control of update timing ([#290](https://github.com/Polymer/lit-element/issues/290)).
103* Updates deferred until first connection ([#258](https://github.com/Polymer/lit-element/issues/258)).
104* Export `TemplateResult` and `SVGTemplateResult` ([#415](https://github.com/Polymer/lit-element/pull/415)).
105### Changed
106* [Breaking] The `createRenderRoot` method has moved from `UpdatingElement` to `LitElement`. Therefore, `UpdatingElement` no longer creates a `shadowRoot` by default ([#391](https://github.com/Polymer/lit-element/issues/391)).
107* [Breaking] Changes property options to add `converter`. This option works the same as the previous `type` option except that the `converter` methods now also get `type` as the second argument. This effectively changes `type` to be a hint for the `converter`. A default `converter` is used if none is provided and it now supports `Boolean`, `String`, `Number`, `Object`, and `Array` ([#264](https://github.com/Polymer/lit-element/issues/264)).
108* [Breaking] Numbers and strings now become null if their reflected attribute is removed (https://github.com/Polymer/lit-element/issues/264)).
109* [Breaking] Previously, when an attribute changed as a result of a reflecting property changing, the property was prevented from mutating again as can happen when a custom
110`converter` is used. Now, the oppose is also true. When a property changes as a result of an attribute changing, the attribute is prevented from mutating again (https://github.com/Polymer/lit-element/issues/264))
111### Fixed
112* [Breaking] User defined accessors are now wrapped to enable better composition ([#286](https://github.com/Polymer/lit-element/issues/286))
113* Type for `eventOptions` decorator now properly includes `passive` and `once` options ([#325](https://github.com/Polymer/lit-element/issues/325))
114
115## [0.6.5] - 2018-12-13
116### Changed:
117* Use lit-html 1.0 release candidate.
118
119### Fixed
120* Types for the `property` and `customElement` decorators updated ([#288](https://github.com/Polymer/lit-element/issues/288) and [#291](https://github.com/Polymer/lit-element/issues/291)).
121* Docs updated.
122
123## [0.6.4] - 2018-11-30
124### Changed
125* Update lit-html dependency to ^0.14.0 ([#324](https://github.com/Polymer/lit-element/pull/324)).
126
127## [0.6.3] - 2018-11-08
128### Changed
129* Update lit-html dependency to ^0.13.0 ([#298](https://github.com/Polymer/lit-element/pull/298)).
130
131## [0.6.2] - 2018-10-05
132
133### Changed
134* LitElement changed to a non-abstract class to be more compatible with the JavaScript mixin pattern
135([#227](https://github.com/Polymer/lit-element/issues/227)).
136* Update lit-html dependency to ^0.12.0 ([#244](https://github.com/Polymer/lit-element/pull/244)).
137* Passes the component's `this` reference to lit-html as the `eventContext`, allowing unbound event listener methods ([#244](https://github.com/Polymer/lit-element/pull/244)).
138### Added
139* A `disconnectedCallback()` method was added to UpdatingElement ([#213](https://github.com/Polymer/lit-element/pull/213)).
140* Added `@eventOptions()` decorator for setting event listener options on methods ([#244](https://github.com/Polymer/lit-element/pull/244)).
141
142## [0.6.1] - 2018-09-17
143
144### Fixed
145* Fixes part rendering and css custom properties issues introduced with lit-html 0.11.3 by updating to 0.11.4 (https://github.com/Polymer/lit-element/issues/202).
146
147### Removed
148* Removed custom_typings for Polymer as they are no longer needed
149(https://github.com/Polymer/lit-element/issues/186).
150
151## [0.6.0] - 2018-09-13
152
153### Added
154* Added `@query()`, `@queryAll()`, and `@customElement` decorators ([#159](https://github.com/Polymer/lit-element/pull/159))
155
156### Changed
157* Significantly changed update/render lifecycle and property API. Render lifecycle
158is now `requestUpdate`, `shouldUpdate`, `update`, `render`, `firstUpdated`
159(first time only), `updated`, `updateComplete`. Property options are now
160`{attribute, reflect, type, hasChanged}`. Properties may be defined in a
161`static get properties` or using the `@property` decorator.
162(https://github.com/Polymer/lit-element/pull/132).
163
164
165### Removed
166* Removed render helpers `classString` and `styleString`. Similar directives
167(`classMap` and `styleMap`) have been added to lit-html and should be used instead
168(https://github.com/Polymer/lit-element/pull/165 and
169https://github.com/Polymer/lit-html/pull/486).
170
171### Fixed
172* The `npm run checksize` command should now return the correct minified size
173(https://github.com/Polymer/lit-element/pull/153).
174* The `firstUpdated` method should now always be called the first time the element
175updates, even if `shouldUpdate` initially returned `false`
176(https://github.com/Polymer/lit-element/pull/173).