Skip to content

Latest commit

 

History

History
126 lines (97 loc) · 4.27 KB

README.md

File metadata and controls

126 lines (97 loc) · 4.27 KB
Raw

Polymer.dart

Polymer.dart is a set of comprehensive UI and utility components for building web applications. With Polymer.dart's custom elements, templating, data binding, and other features, you can quickly build structured, encapsulated, client-side web apps.

Polymer.dart is a Dart port of Polymer created and maintained by the Dart team. The Dart team is collaborating with the Polymer team to ensure that polymer.dart elements and polyfills are fully compatible with Polymer.

Polymer.dart replaces Web UI, which has been deprecated.

Learn More

  • The Polymer.dart homepage contains a list of features, project status, installation instructions, tips for upgrading from Web UI, and links to other documentation.

  • See our TodoMVC example by opening up the Dart Editor's Welcome Page and selecting "TodoMVC".

  • For more information about Dart, see http://www.dartlang.org/.

  • When you use this package, you automatically get the polymer_expressions package, which provides an expressive syntax for use with templates.

Try It Now

Add the polymer.dart package to your pubspec.yaml file:

dependencies:
  polymer: ">=0.9.0 <0.10.0"

Instead of using any, we recommend using version ranges to avoid getting your project broken on each release. Using a version range lets you upgrade your package at your own pace. You can find the latest version number at https://pub.dartlang.org/packages/polymer.

Building and Deploying

To build a deployable version of your app, add the polymer transformers to your pubspec.yaml file:

transformers:
- polymer

Then, run pub build. The polymer transformers assume all files under web are possible entry points, this can be adjusted with arguments in your pubspec.yaml file. For example, you can say only web/index.html is an entry point as follows:

transformers:
- polymer:
    entry_points: web/index.html

Here is a list of arguments used by the polymer transformers:

  • js: whether to load JS code directly. By default polymer converts your app's html file to load the compiled JS code directly. Setting this parameter to false will keep a dart script tag and the dart.js script tag on the page.

  • csp: whether to load a Content Security Policy (CSP) compliant JS file. Dart2js generates two JS files, one that is not CSP compilant and one that is. By default, polymer uses the former becuase it's likely more efficient, but you can choose the latter by setting this flag.

  • entry_points: can be a list of entry points or, for convenience, a single entry point as shown above.

For example, this specification includes 2 entrypoints and chooses the CSP compliant JS file:

transformers:
- polymer:
    entry_points:
    - web/index.html
    - web/index2.html
    csp: true

Contacting Us

Please file issues in our Issue Tracker or contact us on the Dart Web UI mailing list.

We also have the Web UI development list for discussions about internals of the code, code reviews, etc.