Update README for 3.x #5218
Merged
Update README for 3.x #5218
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
keanulee
suggested changes
May 4, 2018
README.md
Outdated
|
|
||
| **To evaluate Polymer 2.0**, please point your bower at the latest `2.0.0` tag for polymer, and be sure load to the `webcomponentsjs/webcomponents-lite.js` or `webcomponentsjs/webcomponents-loader.js` polyfills from the latest `v1.0.0` tag of [`webcomponentsjs`](https://github.com/webcomponents/webcomponentsjs). | ||
| * Runs in browsers with [Javascript Modules](https://caniuse.com/#search=modules): [JSBin](https://jsbin.com/wuxejiz/edit?html,output), |
There was a problem hiding this comment.
JavaScript (casing), here and everywhere
ghost
reviewed
May 4, 2018
README.md
Outdated
| 1. Create a class that extends `PolymerElement`. | ||
| 1. Implement a static `properties` getter that describes the element's public property/attribute API | ||
| (these automatically become observed attributes). | ||
| 1. Then implement a `template` getter that reutrns an `HTMLTemplateElement` describing the element's rendering, including encapsulated styling and any property bindings. |
ghost
reviewed
May 4, 2018
README.md
Outdated
|
|
||
| customElements.define(MyBoundNamecard.is, MyBoundNamecard); | ||
| ``` | ||
| By being based on the Web Components API's built in the browser (or [polyfilled](https://github.com/webcomponents/webcomponentsjs) where needed), elements built with Polymer are: |
There was a problem hiding this comment.
Web Components API's should not have possessive
ghost
reviewed
May 4, 2018
README.md
Outdated
| * Interoperable at the browser level | ||
| * Built from the platform up | ||
| * Self-contained | ||
| * Don't require an overarching framework - are interoperable across frameworks |
There was a problem hiding this comment.
* Don't require an overarching framework - are interoperable across frameworks
->
* Interoperable across frameworks
ghost
reviewed
May 4, 2018
README.md
Outdated
|
|
||
| } | ||
| Polymer 3.0 is now released to stable, and introduces a major change to how Polymer is distributed: from HTML Imports on bower, to JS modules on npm. Otherwise, the API is virtually 100% backward compatible with Polymer 2.0 (the only changes are removing API's related to HTML Imports like `importHref`, and converting Polymer's API to be module-based rather than globals-based). |
There was a problem hiding this comment.
from HTML Imports on bower -> from HTML Imports on Bower
There was a problem hiding this comment.
virtually 100% maybe -> almost entirely or something? Or remove it
ghost
reviewed
May 4, 2018
README.md
Outdated
|
|
||
| } | ||
| Polymer 3.0 is now released to stable, and introduces a major change to how Polymer is distributed: from HTML Imports on bower, to JS modules on npm. Otherwise, the API is virtually 100% backward compatible with Polymer 2.0 (the only changes are removing API's related to HTML Imports like `importHref`, and converting Polymer's API to be module-based rather than globals-based). |
ghost
reviewed
May 4, 2018
README.md
Outdated
| <!-- using the element --> | ||
| <my-styled-namecard my-name="Jesse"></my-styled-namecard> | ||
| ``` | ||
| Migrating to Polyme 3.0 by hand is mostly mechanical: |
ghost
reviewed
May 4, 2018
README.md
Outdated
| ``` | ||
| Migrating to Polyme 3.0 by hand is mostly mechanical: | ||
| * Components should be defined in JS modules instead of in HTML | ||
| * Templates should be encoded in JS modules using a `static get template()` getter on PolymerElement subclasses using the `html` tagged template literal function (which parses `HTMLTemplateElement`'s out of strings in JS) rather than using `<template>` elements in a `<dom-module>` |
There was a problem hiding this comment.
HTMLTemplateElement's -> HTMLTemplateElements
ghost
reviewed
May 4, 2018
README.md
Outdated
| Migrating to Polyme 3.0 by hand is mostly mechanical: | ||
| * Components should be defined in JS modules instead of in HTML | ||
| * Templates should be encoded in JS modules using a `static get template()` getter on PolymerElement subclasses using the `html` tagged template literal function (which parses `HTMLTemplateElement`'s out of strings in JS) rather than using `<template>` elements in a `<dom-module>` | ||
| * All dependencies should be imported JS module imports rather than from HTML Imports. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Update README for 3.x