【转】Polymer API开发指南 (一)(翻译)

原文转自:http://segmentfault.com/blog/windwhinny/1190000000592324

翻译的不好,轻拍

Polymer是google的一款前端开发框架,其基于Shadow DOM、Custom Elements、MDV等最新浏览器特性构建,代表了下一代Web框架的方向:一切皆组件、尽量减少代码量、尽量减少框架限制。

名词解释

  • Attribute: 元素声明或者创建时需要的属性。
  • Property: 属性、元素或者类向外提供的数据区域,例如js对象的属性。
  • Polyfill: 指的是通过第三方脚本对老旧浏览器进行的修补,通过这些修补使之能够支持新浏览器的特性。

Web components标准主要由以下3个部分组成:

  • Custom Elements
  • Shadow DOM
  • HTML Imports

元素声明

Polymer的核心是Custom Elements,定义一个Polymer元素和定义一个普通的Custom Elements是差不多的。主要的区别就是Polymer使用polymer-element标签进行声明。

<polymer-element name="tag-name" constructor="TagName">
  <template>
    <!-- 在这里放置shadow DOM -->
  </template>
  <script>Polymer(‘tag-name‘);</script>
</polymer-element>

Attrubtes

Polymer在polymer-element标签上预留了一些特殊的attribute

Attribute 必要 描述
name Polymer元素名,名称中需要包含"-"
attributes 指定元素的Published properties
extends 指定元素继承其它元素
noscript 不需要调用Polymer()的简单元素
constuctor 放置在全局对象(如window)中的元素构造器名,允许用户通过new来新建此元素.(如: var tagName = new TagName()

默认 Attribute

你在polymer-elemnet上设置的其他 attribute 将会自动添加到元素实例上。例如:

<polymer-element name="tag-name" class="active" mycustomattr>
  <template>...</template>
  <script>Polymer(‘tag-name‘);</script>
</polymer-element>

当一个tag-name实例被创建的时候,它就会自带两个默认 attribute : class="active"mycustomattr

<tag-name class="active" mycustomattr></tag-name>

Attribute大小写

HTML解析器对 attribute 大小写敏感是没有必要的,但是Javascript却对大小写敏感。

书写时你可以忽略属性名的大小写,但是当你运行并查看元素的属性列表时,属性名永远都是小写的,Polymer会谨慎的将* property* 和 attribute 一一配对。例如:

<name-tag nameColor="blue" name="Blue Name"></name-tag>

在DOM中nameColor是小写的,并且通常都会被忽略不处理。

下面例子也都会正常工作:

<name-tag NaMeCoLoR="blue" name="Blue Name"></name-tag>
<name-tag NAMECOLOR="red" name="Red Name"></name-tag>
<name-tag NAMEcolor="green" name="Green Name"></name-tag>

其它声明元素的方法

考虑到重构的需要,我们有时候不会将脚本放置在元素标签里,而是独立成一个文件。Polymer元素也可以通过外部脚本中调用Polymer(‘tag-name‘)来创建。

<!-- 1. 在元素声明内部添加外部脚本 -->
<polymer-element name="tag-name">
  <template>...</template>
  <script src="path/to/tagname.js"></script>
</polymer-element>

<!-- 2. 在元素声明之前添加外部脚本 -->
<script src="path/to/tagname.js"></script>
<polymer-element name="tag-name">
  <template>...</template>
</polymer-element>

<!-- 3. 没有脚本 -->
<polymer-element name="tag-name" constructor="TagName" noscript>
  <template>
    <!-- shadow DOM here -->
  </template>
</polymer-element>

快速注册

元素也可以只通过JS来注册:

<script>
  Polymer(‘name-tag‘, {nameColor: ‘red‘});
  var el = document.createElement(‘div‘);
  el.innerHTML = ‘    <polymer-element name="name-tag" attributes="name">      <template>        Hello <span style="color:{{nameColor}}">{{name}}</span>      </template>    </polymer-element>‘;
  //如果不将这个元素声明放入DOM内的话,custom elements的polyfill就找不到它。
  document.body.appendChild(el);
</script>

<name-tag name="John"></name-tag>

需要注意的是,要将polymer-element放入DOM中,这样custom element的polyfill才能找到它。

添加公开的property和方法

如果你想要定义一些方法或者 property 时(可选),在Polymer()的第二个参数中传递包含定义信息的对象即可。

下面这个例子中,定义了一个property: message , 一个使用到了ES5 getter特性的property: greeting, 还有一个方法:foo

<polymer-element name="tag-name">
  <template></template>
  <script>
    Polymer(‘tag-name‘, {
      message: "Hello!",
      get greeting() {
        return this.message + ‘ there!‘;
      },
      foo: function() {...}
    });
  </script>
</polymer-element>

注释: this是这个Polymer元素在自己内部他本身的引用。例如:this.localName == ‘tag-name‘.

注意: 当元素的property是一个js对象或者数组时需要注意,由于prototype的一些特性,你可能会在同一类元素的不同实体中,陷入shared state问题。如果你想初始化一个property为对象或者数组的时候,不要在prototype中赋值,而应该在created回调中赋值。

// 正确
Polymer(‘x-foo‘, {
  created: function() {
    this.list = []; // Initialize and hint type to be array.
    this.person = {}; // Initialize and hint type to an object.
  }
});

// 错误
Polymer(‘x-foo‘, {
  list: [], // Don‘t initialize array or objects on the prototype.
  person: {}
});

添加私有或者静态property

如果需要私有对象的话,将Polymer()放置在匿名自调函数里即可。

<polymer-element name="tag-name">
  <template>...</template>

<script>
    (function() {
      // 只会运行一次
      var foo_ = new Foo();

      // 每一个实例创建时都会运行
      Polymer(‘tag-name‘, {
        get foo() { return foo_; }
      });
    })();
  </script>

</polymer-element>

支持全局变量

有时候你希望定义一个全局变量,并且在不同的元素中使用它。比如你会定义一个配置信息,然后在其它部件中引用这个配置。或者一个运动曲线用于处理不同的动画效果,或者一个变量用于保存当前登录用户的信息。

你可以使用MonoState Pattern来实现这个目标。当定义一个Polymer元素时,定义一个闭包,将需要的变量放入进去,然后在元素的prototype上设置访问器,或者在构造器里把他们赋值到不同的实例上。

<polymer-element name="app-globals">

<script>
  (function() {
    var firstName = ‘John‘;
    var lastName = ‘Smith‘;

    Polymer(‘app-globals‘, {
       ready: function() {
         this.firstName = firstName;
         this.lastName = lastName;
       }
    });
  })();
  </script>

</polymer-element>

然后像使用其他元素一样把它放置到另一个元素声明里,将需要的property绑定到实例上,这样就可以使用Polymer的数据绑定技术来访问它了。

<polymer-element name="my-component">
  <template>
    <app-globals id="globals"></app-globals>
    <div id="firstname"></div>
    <div id="lastname"></div>
  </template>
  <script>
    Polymer(‘my-component‘, {
      ready: function() { this.globals = this.$.globals; }
     });
  </script>
</polymer-element>

只要做一些轻微的调整,就可以在外部配置全局变量的值了。

<polymer-element name="app-globals">

<script>
  (function() {
    var values = {};

    Polymer(‘app-globals‘, {
       ready: function() {
         for (var i = 0; i < this.attributes.length; ++i) {
           var attr = this.attributes[i];
           values[attr.nodeName] = attr.nodeValue;
         }
       }
    });
  })();
  </script>

</polymer-element>

在主页中,专递 attribute 就可以配置全局变量了。

<app-globals firstName="Addy" lastName="Osmani"></app-globals>

元素生命周期方法

Polymer对于元素声明周期回调有着一流的支持,为了方便,回调函数都用了简短的名称。

所有这些回调都是可选的:

Polymer(‘tag-name‘, {
  created: function() { ... },
  ready: function() { ... },
  attached: function () { ... },
  domReady: function() { ... },
  detached: function() { ... },
  attributeChanged: function(attrName, oldVal, newVal) {
    //var newVal = this.getAttribute(attrName);
    console.log(attrName, ‘old: ‘ + oldVal, ‘new:‘, newVal);
  },
});

下面是custom elements和Polymer元素的生命周期方法的对照表:

Custom Elements Polymer 触发条件
createdCallback created 一个元素的实例被创建
- ready polymer-element已经完全准备好。(例如:shadow DOM创建完成,事件已绑定等等)
attachedCallback attached 当一个元素的实例被插入到DOM中
- domReady Called when the element’s initial set of children are guaranteed to exist. This is an appropriate time to poke at the element’s parent or light DOM children. Another use is when you have sibling custom elements (e.g. they’re .innerHTML‘d together, at the same time). Before element A can use B’s API/properties, element B needs to be upgraded. The domReady callback ensures both elements exist.
detachedCallback detached 当实例从DOM中移除
attributeChangedCallback attributeChanged attribute被添加移除或者改变。注意: 要监听一个公开的property,应该使用 changed watchers

polymer-ready 事件

Polymer通过异步的方式来处理自定义元素定义和升级。如果你在元素还没有升级的时候,就通过DOM来获取它,你只会得到一个HTMLUnknownElement。Polymer元素有时还会使用外部元素,例如css,如果他们还没有完全加载完毕,就可能引起FOUC的问题。为了避免FOUC,Polymer只有在css等资源全部加载完毕之后才会注册元素。

通过polymer-ready事件就可以得知元素何时注册/升级完。

<head>
  <link rel="import" href="path/to/x-foo.html">
</head>
<body>
  <x-foo></x-foo>
  <script>
    window.addEventListener(‘polymer-ready‘, function(e) {
      var xFoo = document.querySelector(‘x-foo‘);
      xFoo.barProperty = ‘baz‘;
    });
  </script>
</body>
时间: 2024-10-09 05:07:54

【转】Polymer API开发指南 (一)(翻译)的相关文章

【转】Polymer API开发指南 (二)(翻译)

原文转自:http://segmentfault.com/blog/windwhinny/1190000000596258 公开 property 当你公开一个 Polymer 元素的 property 名字时,就等于把这个 property 设置为公开API了.公开 property 会有如下的特性: 支持声明数据双向绑定 通过声明,property 将会按照名称一样的 html attribute 初始化数据 property 的值可以反射到元素对应的attribute上 注: proper

WatchKit-Programming-Guide-Apple-Watch开发指南官方翻译及总结

鉴于CSDN的Markdown很多bug,大家请看这里: WatchKit-Programming-Guide-Apple-Watch开发指南官方翻译及总结 Overview ### Developing for Apple Watch Apple Watch可以让用户以一种很私密,不招摇的样式查看信息(官方文档是这样的哈,但是我想大多数人不会不招摇的查看Apple Watch上的信息??).用户可以在不拿出手机的情况下,通过查看Apple Watch快速的获取重要的信息. Apple Watc

来自HeroKu的HTTP API 设计指南(中文版)

原文转自:http://get.jobdeer.com/343.get 来自HeroKu的HTTP API 设计指南(中文版) 翻译 by @Easy 简介 本指南中文翻译者为 @Easy ,他是国内首家互联网人才拍卖网站 JobDeer.com 的创始人.转载请保留本信息. 本指南描述了一系列 HTTP+JSON API 的设计实践, 来自并展开于 Heroku Platform API 的工作.本指南指导着Heroku内部API的开发,我们希望也能对Heroku以外的API设计者有所帮助.

融云IM 基础服务开发指南WebIMLib API 示例 【干货】

Web SDK API 示例 简介 融云 Web SDK API 用法及常见异常总结,为了方便刚接触融云 Web SDK 开发者朋友们写下此文档,希望可以帮到你们. 说明: 1.函数参数中使用 [] 为可选参数(数组除外). 2.**** => **** 在本文档中表示为示例代码和结果,例:1+2 => 3. 初始化 初始化 SDK 执行初始化需要在开发者后台新建应用得到 AppKey 和 token,初始化代码: RongIMLib.RongIMClient.init(appkey,[dat

握手API网关(7)开发指南-API参考

一.简介 用户可以使用开发指南介绍的 API 对 API 网关服务进行相关操作. 术语表 术语 全称 中文 说明 Region   地域 用户开放API,需选择API在API网关的部署地域,建议选择与后端服务相同的Region. API   应用程序编程接口 用户开放API,在API网关录入API,以提供接口的方式对外提供服务或者数据. Group API Group API分组 一组API. 用户开放API,首先需要创建API分组 每个API分组拥有一个二级域名,两个Stage 用户需要将已经

WP8.1小梦词典开发2:百度翻译API使用

原文出自:http://www.bcmeng.com/api2/ 小梦昨天和大家分享了WP8.1金山词霸API使用方法,今天继续分享windows phone 8.1中百度翻译API的使用方法.和昨天一样首先我们需要申请百度翻译API的Key: 百度翻译API的Key的申请: 进入 http://developer.baidu.com/ 需要一个百度账号,注册登陆后. 点击右上方的  管理服务台 ,选择开发者服务管理,进入口,选择创建工程就可以.创建工程完成后,你就可以拿到你的Key.和金山词霸

AutoCAD二次开发&mdash;&mdash;AutoCAD.NET API开发环境搭建

AutoCAD二次开发--AutoCAD.NET API开发环境搭建 AutoCAD二次开发--AutoCAD.NET API开发环境搭建 AutoCAD二次开发工具:1986年AutoLisp,1989年ADS,1990年DCL,1993年ADS-RX,1995年ObjectARX,1996年Active X Automation(COM),1997年VBA,1998年Visual Lisp,2006年.net API(DLL). 趋势和方向:AutoCAD.net API(AutoCAD20

[转]苹果App Store审核指南中文翻译

原文地址:http://www.cocoachina.com/newbie/basic/2014/0227/7892.html 前言 感谢您付出宝贵的才华与时间来开发iOS应用程程序.从职业与报酬的角度而言,这对于成千上万的开发员来说一直都是一项值得投入的事业,我们希望帮助您加入这个成功的组织.我们发布了<App Store审核指南>(App Store Review Guidelines),希望通过它帮您避开开发应用程序过程中的一些问题,并帮你在提交应用时加快审核流程. 我们将应用程序(A

Knockout应用开发指南

第一章:入门 1.Knockout简介 (Introduction) Knockout是一个轻量级的UI类库,通过应用MVVM模式使JavaScript前端UI简单化. Knockout有如下4大重要概念: 声明式绑定 (Declarative Bindings):使用简明易读的语法很容易地将模型(model)数据关联到DOM元素上. UI界面自动刷新 (Automatic UI Refresh):当您的模型状态(model state)改变时,您的UI界面将自动更新. 依赖跟踪 (Depend