@webtides/element-js 0.3.3

package/CHANGELOG.md

@@ -0,0 +1,58 @@
+# Change Log
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](http://keepachangelog.com/) and this project adheres to [Semantic Versioning](http://semver.org/).
+
+<!--
+   PRs should document their user-visible changes (if any) in the
+   Unreleased section, uncommenting the header as necessary.
+-->
+
+<!-- ## Unreleased -->
+<!-- ### Added -->
+<!-- ### Changed -->
+<!-- ### Removed -->
+<!-- ### Fixed -->
+
+## [0.3.3] - 2021-09-22
+
+### Added
+* optional complex event callback notation to support addEventListener options (i.E. for passive Event Listeners )
+* Example:  {listener: () => {}, options: { passive: true } }
+* docs
+* tests
+
+
+## [0.3.2] - 2021-03-09
+
+### Added
+* bundled version of `element-js` to use from a CDN and be able to prototype in tools like CodePen etc.
+
+## [0.3.1] - 2020-12-08
+
+### Fixed 
+* i18n fallback values
+
+### Added
+* i18n tests
+
+## [0.3.0] - 2020-07-27
+
+### Added
+* first batch/draft of the documentation
+* property/attribute reflection via constructor options (see the [Documentation](/docs/README.md#propertyoptions) for more info)
+* mutationObserverOptions to enable observing subtree mutations (see the [Documentation](/docs/README.md#mutationobserveroptions) for more info)
+
+### Removed
+* `childListUpdate` constructor option has been deprecated and will be removed before `1.0`
+
+## [0.2.0] - 2020-07-01
+
+### Changed
+* uses shady-render instead of render from `lit-html` for rendering templates to be compatible with the shady-css polyfill
+* refactored and simplified `StyledElement`s handling/loading of style sheets
+
+## [0.1.0] - 2020-06-26
+
+* initial release

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2019 Eddy Löwen
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,86 @@
+# element-js
+
+Simple and lightweight base classes for web components with a beautiful API
+
+## Introduction
+
+`element-js` lets you write simple, declarative and beautiful web components without the boilerplate. It uses `lit-html` for rendering.
+
+## How to use
+
+#### Installation
+
+install `element-js`
+
+```sh
+npm install --save @webtides/element-js
+```
+
+#### Use / Example Element
+
+`element-js` elements are plain ES6 classes (vanilla JS) with some nice mappings (eg. properties, watch, etc.).
+
+```javascript
+// Import from a CDN
+// import { BaseElement, defineElement } from 'https://unpkg.com/@webtides/element-js';
+// import { BaseElement, defineElement } from 'https://cdn.skypack.dev/@webtides/element-js';
+// or when installed via npm
+import { BaseElement, defineElement } from '@webtides/element-js';
+
+class ExampleElement extends BaseElement {
+    // normal public properties
+    greeting = 'Hello';
+    name = 'John';
+
+    // lifecycle hook
+    connected() {
+        this.greet();
+    }
+
+    // reactive attributes/properties
+    properties() {
+        return {
+            familyName: 'Doe'
+        };
+    }
+
+    // watchers for property changes
+    watch() {
+        return {
+            familyName: (newValue, oldValue) => {
+                console.log('familyName changed', newValue, oldValue);
+            }
+        };
+    }
+
+    // computed property
+    get computedMsg() {
+        return `${this.greeting} ${this.name} ${this.familyName}`;
+    }
+
+    // method
+    greet() {
+        alert('greeting: ' + this.computedMsg);
+    }
+}
+defineElement('example-element', ExampleElement);
+```
+
+To use this element, just import it and use it like any other HTML element
+
+```html
+<script type="module" src="example-element.js" />
+<example-element family-name="Smith"></example-element>
+```
+
+## Documentation
+
+For detailed documentation see the [Docs](docs/README.md).
+
+## Contributing & Development
+
+For contributions and development see [contributing docs](.github/CONTRIBUTING.md)
+
+## License
+
+`element-js` is open-sourced software licensed under the MIT [license](LICENSE).