You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@weex.apache.org by ha...@apache.org on 2018/01/18 04:04:12 UTC

[1/3] incubator-weex-site git commit: * [doc] update documents about front-end frameworks

Repository: incubator-weex-site
Updated Branches:
  refs/heads/master e9aa500a2 -> 841771fc1


* [doc] update documents about front-end frameworks


Project: http://git-wip-us.apache.org/repos/asf/incubator-weex-site/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-weex-site/commit/2e7c2fbc
Tree: http://git-wip-us.apache.org/repos/asf/incubator-weex-site/tree/2e7c2fbc
Diff: http://git-wip-us.apache.org/repos/asf/incubator-weex-site/diff/2e7c2fbc

Branch: refs/heads/master
Commit: 2e7c2fbc068796a0d2087eb9173e1e1245a1809d
Parents: a4d6c39
Author: Hanks <zh...@gmail.com>
Authored: Tue Dec 26 10:56:38 2017 +0800
Committer: Hanks <zh...@gmail.com>
Committed: Sun Jan 7 21:10:26 2018 +0800

----------------------------------------------------------------------
 source/guide/front-end-frameworks.md | 127 ++++++++++++++++++++----------
 source/guide/index.md                |   4 +-
 2 files changed, 86 insertions(+), 45 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/incubator-weex-site/blob/2e7c2fbc/source/guide/front-end-frameworks.md
----------------------------------------------------------------------
diff --git a/source/guide/front-end-frameworks.md b/source/guide/front-end-frameworks.md
index 4959a43..a152303 100644
--- a/source/guide/front-end-frameworks.md
+++ b/source/guide/front-end-frameworks.md
@@ -8,90 +8,131 @@ version: 2.1
 
 <!-- toc -->
 
-Writing UIs in declarative way.
+![Vue and Rax](./images/vue-rax.png)
 
 ## Front-end Frameworks in Weex
 
-![Vue and Rax](./images/vue-rax.png)
+Front-end frameworks are just the syntax layer of weex, they are decoupled from native render engines. That is to say, Weex does not relay on any specific front-end frameworks. Currently, Weex mainly supports [Vue.js](https://vuejs.org/) and [Rax](https://alibaba.github.io/rax/), and those frameworks are already integrated into Weex SDK, you don't need to require them manually.
 
 Front-end technologies seem flourishing and productive. ~~Test, build, debug, tools, 3td-party libs.~~
 
-The structure of Weex is decoupled, it isn't relay on any specific front-end frameworks, the DOM operations will convert into render directives and send to native render engine.
+The DOM operations will convert into render directives and send to native render engine.
 
 With the evolution of technology, even if Vue.js and React are not popular any more few years later, Weex can integrate the new widely-used front-end frameworks as well.
 
+It is better to learn some basics of Vue.js or Rax before using Weex.
+
 ## Vue.js
 
-Using v2.x.x version of Vue.js.
+Vue (pronounced /vjuː/, like view) is a progressive front-end framework for building user interfaces.
 
-> If there is no special instructions, when I mentioned *Vue.js*, it actually refers *Vue.js 2.x.x*.
+> **[Official Website](https://vuejs.org/)**
+
+Weex integrates with the v2 version of Vue.js since WeexSDK [v0.10.0](https://github.com/alibaba/weex/releases/tag/v0.10.0) (2016/02/17). If there is no special instructions, the "*Vue.js*" or "*Vue*" in this article all refers to "Vue.js v2".
 
 ### Runtime-only Build
 
-When using vue-loader or vueify, templates inside *.vue files are pre-compiled into JavaScript at build time. You don’t really need the compiler in the final bundle, and can therefore use the runtime-only build.
+If you are familiar with Vue.js, you should know that there are two available builds of Vue.js: [the **Runtime + Compiler** build and the **Runtime-only** build](https://vuejs.org/v2/guide/installation.html#Standalone-vs-Runtime-only-Build). The difference between them is whether to include the compiler which is able to compile the `template` option at runtime.
+
+Since the runtime-only builds are roughly 30% lighter-weight than their full-build counterparts, Weex is using the runtime-only build of Vue.js for better performance and less code size.
 
-Vue.js provides two available builds: the **Runtime + Compiler** build and the **Runtime-only** build. See its [official document](https://vuejs.org/v2/guide/installation.html#Standalone-vs-Runtime-only-Build) for more information.
+Specifically, the differences are as follows:
+
++ The [`template`](https://vuejs.org/v2/api/#template) option is not supported when defining a component.
++ Does not support using [`x-templates`](https://vuejs.org/v2/guide/components.html#X-Templates).
++ Does not support using [`Vue.compile`](https://vuejs.org/v2/api/#Vue-compile).
+
+### Different Features
+
+Vue.js was designed for the Web platform at the beginning. Although it can be based on Weex to develop native applications, there are still many differences between web and native. See [Platform Differences Between Weex and Web](../ platform-difference.html) for more details.
+
+#### Platform
+
++ Weex is a multi-page app, the `Vue` instances are different in each pages.
+
+#### DOM
+
+Because there is no DOM on Android and iOS, the type of [`vm.$el`](https://vuejs.org/v2/api/#vm-el) property is not the DOM element (`HTMLElement`).
+
+Do not manipulate the generated (DOM) elements manually.
+
+#### Styles
+
++ Scoped styles by default, by force.
++ Single class selector.
 
-Weex only required the runtime-only build of Vue.js for better performance and less code size.
+#### Events
 
-The specific differences are:
+Event bubbling and capturing are not supported in Weex currently, therefore, [event modifiers](https://vuejs.org/v2/guide/events.html#Event-Modifiers) such as `.prevent`, ` .capture`, `.stop`, ` .self` are not supported on Weex native components.
 
-+ The `template` attribute is not supported when defining a component.
-+ Does not support using `x-templates`.
-+ Does not support using `Vue.compile`.
+Moreover, the [keyboard event modifiers](https://vuejs.org/v2/guide/events.html#Key-Modifiers) and [system modifier keys](https://vuejs.org/v2/guide/events.html#System-Modifier-Keys), such as `.enter`, `.tab`, `.ctrl`, `.shift` mostly are meaningless on mobile device, which are also not supported in Weex.
+
+#### Supported Directives
+
+| Directive | Supported | Notes |
+| --------- | --------- | ----- |
+| [v-text](https://vuejs.org/v2/api/#v-text) | Yes |  |
+| [v-pre](https://vuejs.org/v2/api/#v-pre) | Yes |  |
+| [v-html](https://vuejs.org/v2/api/#v-html) | No | No HTML parser in Weex, and it's not good practice. |
+| [v-show](https://vuejs.org/v2/api/#v-show) | No | Not support `display: none;` yet. |
+| [v-if](https://vuejs.org/v2/api/#v-if) | Yes |  |
+| [v-else](https://vuejs.org/v2/api/#v-else) | Yes |  |
+| [v-else-if](https://vuejs.org/v2/api/#v-else-if) | Yes |  |
+| [v-for](https://vuejs.org/v2/api/#v-for) | Yes |  |
+| [v-on](https://vuejs.org/v2/api/#v-on) | Yes |  |
+| [v-once](https://vuejs.org/v2/api/#v-once) | Yes |  |
+| [v-bind](https://vuejs.org/v2/api/#v-bind) | Yes |  |
+| [v-model](https://vuejs.org/v2/api/#v-model) | Yes |  |
+| [v-cloak](https://vuejs.org/v2/api/#v-cloak) | No | Only support single class selector. |
 
 ### weex-vue-render
 
-### Compile `*.vue` files
+The [weex-vue-render](https://github.com/weexteam/weex-vue-render) implement the built-in components and modules of Weex on the web.
+
+### Single File Component
+
+[Single file component](https://vuejs.org/v2/guide/single-file-components.html) (as known as the `*.vue` files) of Vue is a special file format with a `.vue` extension. The template inside will be compiled into the `render` function at build time.
 
+Moreover, there are many [syntax highlight plugins](https://github.com/vuejs/awesome-vue#source-code-editing) for all kind of editors.
+
+> It's a good practice to use single file component syntax in Weex.
 
 Because of the platform difference and 利用 web 本身特性的性能, you have to compile your source file in two different ways:
 
-+ For the web, you can compile source files in any official way, such as Webpack + vue-loader or Browserify + vueify. and require the [weex-vue-render](https://www.npmjs.com/package/weex-vue-render), which is a group of Weex build-in components.
-+ For Android and iOS, we've provided [weex-loader](https://github.com/weexteam/weex-loader) to compile the `*.vue` files. That is, use Webpack + weex-loader to generate the js bundle that is available for the native.
++ For the web platform, you can compile source files in any official way, such as [Webpack](https://webpack.js.org/) + [vue-loader](https://vue-loader.vuejs.org/en/) or Browserify + vueify.
++ For Android and iOS platforms, you should use [weex-loader](https://github.com/weexteam/weex-loader) to compile the `*.vue` files.
 
-#### Using `weex-loader`
+#### Using weex-loader
 
-[weex-loader](https://github.com/weexteam/weex-loader) is a loader for Webpack, see the [official document](http://webpack.github.io/docs/using-loaders.html) to learn how to use it.
+[weex-loader](https://github.com/weexteam/weex-loader) is a [loader](http://webpack.github.io/docs/using-loaders.html) for webpack that can transform `*.vue` file into a plain javascript module for Android and iOS platform. All features and configurations of it are same with [vue-loader](https://vue-loader.vuejs.org/en/).
 
-One more thing should be reminded is that if the *entry file* of your webpack config is a `.vue` file, you also need to pass an additional ` entry` parameter, usually set to `true`.
+One thing should be noted that if the *entry* option of your Webpack config is a `*.vue` file, you also need to pass an additional `entry` parameter.
 
-```Js
-module.exports = {
+```js
+const webpackConfig = {
   // Add the entry parameter for the .vue file
-  entry: './path/to/App.vue?entry=true',
+  entry: './path/to/App.vue?entry=true'
 
-  // other configurations ...
+  /* ... */
 
-  module: {
+  use: {
     loaders: [{
-
-      // matches the .vue file path that contains the entry parameter
+      // matches the .vue file path which contains the entry parameter
       test: /\.vue(\?^^]+)?$/,
       loaders: ['weex-loader']
     }]
-  },
+  }
 }
 ```
 
-**You don't need to write those additional parameters if you are using `.js` file as entry file.** We recommend using javascript file as the entry file of webpack config.
-
-### Restrictions
+**You don't need to write those additional parameters if you are using `.js` file as entry file.** It's a good practice to using javascript file as the entry file of webpack config.
 
-+ Scoped styles by default, by force.
-
-Vue.js was designed for the Web platform at the beginning. Although it can be based on Weex to develop native applications, there are still many differences between web and native. See [Platform Differences Between Weex and Web](../ platform-difference.html) for more details.
-
-Due to those differences, Weex doesn't support those features in Vue.js (mostly are DOM-related):
-
-+ Event bubbling and capturing are not supported.
-  + Event modifiers, such as `.prevent`,` .capture`, `.stop`,` .self` are meaningless in the native environment.
-  + The keyboard event modifiers, like `.{KeyCode | keyAlias}` is also meaningless. (see [docs in Vue.js](https://vuejs.org/v2/guide/events.html#Key-Modifiers))
-+ The `v-html` and `v-text` directives are not supported.
-+ Not support `v-show`, `v-cloak` and `<keep-alive>`, because Weex doesn't support `display:none;` yet.
-+ `vm.$el` is Weex Virtual-DOM Element, not the `HTMLElement`.
-+ No need to call `vm.$mount` manually, the entry component will mount to the root view of the native container by default. No need `Vue.mount()`.
+```Js
+{
+  entry: './path/to/entry.js'
+}
+```
 
 ## Rax
 
-Rax is a front-end framework with largely React-compatible APIs.
+Rax is a front-end framework with React-compatible APIs.

http://git-wip-us.apache.org/repos/asf/incubator-weex-site/blob/2e7c2fbc/source/guide/index.md
----------------------------------------------------------------------
diff --git a/source/guide/index.md b/source/guide/index.md
index 61184ac..e6b92c5 100644
--- a/source/guide/index.md
+++ b/source/guide/index.md
@@ -20,7 +20,7 @@ Another primary goal of Weex is to keep up with modern development technologies
 
 ## Overview
 
-If you just want to try Weex, You don't need to install anything. There is an [online playground](http://dotwe.org/vue/) of Weex, you can write single page examples on it without any configurations. The source code should be written in Vue.js [single file component](https://vuejs.org/v2/guide/single-file-components.html) syntax, and the render result of the web platform will be displayed in a mocked phone shell.
+If you just want to try Weex, You don't need to install anything. There is an [online playground](http://dotwe.org/vue/) of Weex, you can write single page examples on it without any configurations. The source code should be written in Vue.js [single file component](https://vuejs.org/v2/guide/single-file-components.html) syntax (as known as the `*.vue` files), and the render result of the web platform will be displayed in a mocked phone shell.
 
 Here is an [example](http://dotwe.org/vue/8da01827631b21150a12dd54d7114380) written in Weex and Vue.js:
 
@@ -62,7 +62,7 @@ Here are some documents about how to extend native components and native modules
 + [Extend Android](./extend-android.html)
 + [Extend iOS](./extend-ios.html)
 
-### Write Once, Run Anywhere
+### Write Once, Run Everywhere
 
 Yes, Weex can build for Android, iOS and Web from a single codebase.
 


[3/3] incubator-weex-site git commit: [doc] add document about how to use Vue in Weex (#27)

Posted by ha...@apache.org.
[doc] add document about how to use Vue in Weex (#27)


Project: http://git-wip-us.apache.org/repos/asf/incubator-weex-site/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-weex-site/commit/841771fc
Tree: http://git-wip-us.apache.org/repos/asf/incubator-weex-site/tree/841771fc
Diff: http://git-wip-us.apache.org/repos/asf/incubator-weex-site/diff/841771fc

Branch: refs/heads/master
Commit: 841771fc1e257b39e8c6266e5aca8b139d3c785d
Parents: e9aa500 8dfa577
Author: Hanks <zh...@gmail.com>
Authored: Thu Jan 18 12:02:40 2018 +0800
Committer: Hanks <zh...@gmail.com>
Committed: Thu Jan 18 12:02:40 2018 +0800

----------------------------------------------------------------------
 source/guide/front-end-frameworks.md | 127 +++++++++-----
 source/guide/index.md                |   4 +-
 source/guide/use-vue.md              | 268 ++++++++++++++++++++++++++++++
 3 files changed, 354 insertions(+), 45 deletions(-)
----------------------------------------------------------------------



[2/3] incubator-weex-site git commit: * [doc] add document about how to use vue in weex

Posted by ha...@apache.org.
* [doc] add document about how to use vue in weex


Project: http://git-wip-us.apache.org/repos/asf/incubator-weex-site/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-weex-site/commit/8dfa5774
Tree: http://git-wip-us.apache.org/repos/asf/incubator-weex-site/tree/8dfa5774
Diff: http://git-wip-us.apache.org/repos/asf/incubator-weex-site/diff/8dfa5774

Branch: refs/heads/master
Commit: 8dfa577455119729c86d5befebbf829cdb4a4649
Parents: 2e7c2fb
Author: Hanks <zh...@gmail.com>
Authored: Sat Jan 13 21:09:08 2018 +0800
Committer: Hanks <zh...@gmail.com>
Committed: Sat Jan 13 21:09:08 2018 +0800

----------------------------------------------------------------------
 source/guide/use-vue.md | 268 +++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 268 insertions(+)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/incubator-weex-site/blob/8dfa5774/source/guide/use-vue.md
----------------------------------------------------------------------
diff --git a/source/guide/use-vue.md b/source/guide/use-vue.md
new file mode 100644
index 0000000..561ad65
--- /dev/null
+++ b/source/guide/use-vue.md
@@ -0,0 +1,268 @@
+---
+title: Use Vue.js on Weex
+type: guide
+group: Overview
+order: 1.6
+version: 2.1
+---
+
+<!-- toc -->
+
+Weex integrated the v2 version of Vue.js since WeexSDK [v0.10.0](https://github.com/alibaba/weex/releases/tag/v0.10.0) is released at 2016/02/17. Vue (pronounced /vjuː/, like view) is a progressive front-end framework for building user interfaces. Please refer to its [official website](https://vuejs.org/) for more information.
+
+> If there is no special instructions, the "Vue.js" or "Vue" in this article all refers to the v2 version of Vue.js.
+
+## Runtime-only Build
+
+If you are familiar with Vue.js, you should know that there are two available builds of Vue.js: [the **Runtime + Compiler** build and the **Runtime-only** build](https://vuejs.org/v2/guide/installation.html#Standalone-vs-Runtime-only-Build). The difference between them is whether to include the compiler which is able to compile the `template` option at runtime.
+
+Since the runtime-only builds are roughly 30% lighter-weight than their full-build counterparts, Weex is using the runtime-only build of Vue.js for better performance and less code size.
+
+Specifically, the differences are as follows:
+
++ The [`template`](https://vuejs.org/v2/api/#template) option is not supported when defining a component.
++ Does not support using [`x-templates`](https://vuejs.org/v2/guide/components.html#X-Templates).
++ Does not support using [`Vue.compile`](https://vuejs.org/v2/api/#Vue-compile).
+
+## Platform Differences
+
+Vue.js was designed for the Web platform at the beginning. Although it can be based on Weex to develop native applications, there are still many [platform differences between Weex and web](../wiki/platform-difference.html).
+
+The key platform differences are context, DOM, styles and events.
+
+### Context
+
+Weex is mostly used to write multi-page applications, each page is a native *View* or *Activity* on mobile, and has its own context. In particular, the `Vue` instances are different in each pages, and even the "global" config of Vue (`Vue.config.xxx`) only affect the single page on Weex.
+
+On this basis, some SPA (single-page application) technologies of Vue, such as [Vuex](https://vuex.vuejs.org/en/) and [vue-router](https://router.vuejs.org/en/) will also take effect within the single page. More colloquially, the "page" concept is virtual in SPA technologies, but it is real on Weex.
+
+However, Vuex and vue-router are standalone libraries, they all have their own concept and usage scenario, you can still [use Vuex and vue-router](./advanced/use-vuex-and-vue-router.html) on Weex.
+
+### DOM
+
+Because there is no DOM (document object model) on Android and iOS, if you are manipulating and generating DOM elements manually, it may have some compatibility issues. It is a good practice to manipulate data and components instead of generated elements when you are using modern front-end frameworks.
+
+Some DOM-related features, such as `v-html`, `vm.$el`, `template` option, may not have the same behavior on different platforms.
+
+To be more specific, the type of [`vm.$el`](https://vuejs.org/v2/api/#vm-el) property is `HTMLElement` on the web, but it is not that type on mobile environments. Actually it's a special data structure defined by *Weex document object model*.
+
+### Styles
+
+The style sheet and CSS rules in managed by Weex js framework and native render engines. It would be very difficult and unnecessary to implement the whole CSSOM spec and support all CSS rules.
+
+For performance reasons, **Weex only support single class selector currently, and only support a subset of CSS Rules**. Please refer to *[common styles](../wiki/common-styles.html)* and *[text styles](../wiki/text-styles.html)* for more details.
+
+On Weex, styles are *[scoped](https://vue-loader.vuejs.org/en/features/scoped-css.html)* by force for each Vue component.
+
+### Events
+
+Event bubbling and capturing are not supported in Weex currently, therefore, [event modifiers](https://vuejs.org/v2/guide/events.html#Event-Modifiers) such as `.prevent`, ` .capture`, `.stop`, ` .self` are not supported on Weex native components.
+
+Moreover, the [keyboard event modifiers](https://vuejs.org/v2/guide/events.html#Key-Modifiers) and [system modifier keys](https://vuejs.org/v2/guide/events.html#System-Modifier-Keys), such as `.enter`, `.tab`, `.ctrl`, `.shift` mostly are meaningless on mobile device, which are also not supported in Weex.
+
+## The Web Renderer
+
+If you want to render your page on the web, you need to require the [weex-vue-render](https://github.com/weexteam/weex-vue-render) to achieve it.
+
+`weex-vue-render` is a web renderer for Vue DSL, it implemented the built-in components and built-in modules of Weex on the web. Please refer to [its repo](https://github.com/weexteam/weex-vue-render) for more details.
+
+## Single File Component
+
+[Single file component](https://vuejs.org/v2/guide/single-file-components.html) (as known as the `*.vue` files) of Vue is a special file format with a `.vue` extension. The template inside will be compiled into the `render` function at build time.
+
+Moreover, there are a good deals of [syntax highlight plugins](https://github.com/vuejs/awesome-vue#source-code-editing) for all kind of editors.
+
+> It's a good practice to use single file component syntax in Weex.
+
+### Compile Targets
+
+Because of the platform difference and to improve the performance on the web, the `*.vue` file should be compiled in two different ways:
+
++ For the web platform, you can compile source files in any official way, such as [Webpack](https://webpack.js.org/) + [vue-loader](https://vue-loader.vuejs.org/en/) or Browserify + vueify.
++ For Android and iOS platforms, you should use [weex-loader](https://github.com/weexteam/weex-loader) to compile the `*.vue` files.
+
+Use different bundles for different platforms is to make good use of the platform original features and reduce compatibility code at build time. But the source code is still the same, the only difference is the way to compile it.
+
+### Use weex-loader
+
+[weex-loader](https://github.com/weexteam/weex-loader) is a [loader](http://webpack.github.io/docs/using-loaders.html) for webpack that can transform `*.vue` file into a plain javascript module for Android and iOS platform. All features and configurations of it are same with [vue-loader](https://vue-loader.vuejs.org/en/).
+
+One thing should be noted that if the *entry* option of your Webpack config is a `*.vue` file, you also need to pass an additional `entry` parameter.
+
+```js
+const webpackConfig = {
+  // Add the entry parameter for the .vue file
+  entry: './path/to/App.vue?entry=true'
+
+  /* ... */
+
+  use: {
+    loaders: [{
+      // matches the .vue file path which contains the entry parameter
+      test: /\.vue(\?^^]+)?$/,
+      loaders: ['weex-loader']
+    }]
+  }
+}
+```
+
+**You don't need to write those additional parameters if you are using `.js` file as entry file.** It's a good practice to using javascript file as the entry file of webpack config.
+
+```Js
+{
+  entry: './path/to/entry.js'
+}
+```
+
+## Supported Features
+
+### Global Config
+
+> The Vue "Global" config only affect the single page on Weex, the configuration will not be shared between different Weex pages.
+
+| Vue Global API | Supported | Notes |
+| -------------- | --------- | ----- |
+| [Vue.config.silent](https://vuejs.org/v2/api/#silent)                               | <b class="tag-yes">Yes</b> | - |
+| [Vue.config.optionMergeStrategies](https://vuejs.org/v2/api/#optionMergeStrategies) | <b class="tag-yes">Yes</b> | - |
+| [Vue.config.devtools](https://vuejs.org/v2/api/#devtools)                           | <b class="tag-no">No</b>   | Only supported on the web. |
+| [Vue.config.errorHandler](https://vuejs.org/v2/api/#errorHandler)                   | <b class="tag-yes">Yes</b> | - |
+| [Vue.config.warnHandler](https://vuejs.org/v2/api/#warnHandler)                     | <b class="tag-yes">Yes</b> | - |
+| [Vue.config.ignoredElements](https://vuejs.org/v2/api/#ignoredElements)             | <b class="tag-yes">Yes</b> | Not Recommended. |
+| [Vue.config.keyCodes](https://vuejs.org/v2/api/#keyCodes)                           | <b class="tag-no">No</b>   | Useless on the mobile. |
+| [Vue.config.performance](https://vuejs.org/v2/api/#performance)                     | <b class="tag-no">No</b>   | Same with *devtools*. |
+| [Vue.config.productionTip](https://vuejs.org/v2/api/#productionTip)                 | <b class="tag-yes">Yes</b> | - |
+
+### Global API
+
+| Vue Global API | Supported | Notes |
+| -------------- | --------- | ----- |
+| [Vue.extend](https://vuejs.org/v2/api/#Vue-extend)       | <b class="tag-yes">Yes</b> | - |
+| [Vue.nextTick](https://vuejs.org/v2/api/#Vue-nextTick)   | <b class="tag-yes">Yes</b> | - |
+| [Vue.set](https://vuejs.org/v2/api/#Vue-set)             | <b class="tag-yes">Yes</b> | - |
+| [Vue.delete](https://vuejs.org/v2/api/#Vue-delete)       | <b class="tag-yes">Yes</b> | - |
+| [Vue.directive](https://vuejs.org/v2/api/#Vue-directive) | <b class="tag-yes">Yes</b> | - |
+| [Vue.filter](https://vuejs.org/v2/api/#Vue-filter)       | <b class="tag-yes">Yes</b> | - |
+| [Vue.component](https://vuejs.org/v2/api/#Vue-component) | <b class="tag-yes">Yes</b> | - |
+| [Vue.use](https://vuejs.org/v2/api/#Vue-use)             | <b class="tag-yes">Yes</b> | - |
+| [Vue.mixin](https://vuejs.org/v2/api/#Vue-mixin)         | <b class="tag-yes">Yes</b> | - |
+| [Vue.version](https://vuejs.org/v2/api/#Vue-version)     | <b class="tag-yes">Yes</b> | - |
+| [Vue.compile](https://vuejs.org/v2/api/#Vue-compile)     | <b class="tag-no">No</b>   | Weex is using the [runtime-only build](https://vuejs.org/v2/guide/installation.html#Runtime-Compiler-vs-Runtime-only). |
+
+### Options
+
+| Vue Option | Supported | Notes |
+| ---------- | --------- | ----- |
+| [data](https://vuejs.org/v2/api/#data)                     | <b class="tag-yes">Yes</b> | - |
+| [props](https://vuejs.org/v2/api/#props)                   | <b class="tag-yes">Yes</b> | - |
+| [propsData](https://vuejs.org/v2/api/#propsData)           | <b class="tag-yes">Yes</b> | - |
+| [computed](https://vuejs.org/v2/api/#computed)             | <b class="tag-yes">Yes</b> | - |
+| [methods](https://vuejs.org/v2/api/#methods)               | <b class="tag-yes">Yes</b> | - |
+| [watch](https://vuejs.org/v2/api/#watch)                   | <b class="tag-yes">Yes</b> | - |
+| [el](https://vuejs.org/v2/api/#el)                         | <b class="tag-yes">Yes</b> | The value of `el` is meaningless on the mobile. |
+| [template](https://vuejs.org/v2/api/#template)             | <b class="tag-no">No</b>   | Weex is using the [runtime-only build](https://vuejs.org/v2/guide/installation.html#Runtime-Compiler-vs-Runtime-only). |
+| [render](https://vuejs.org/v2/api/#render)                 | <b class="tag-yes">Yes</b> | Not Recommended. |
+| [renderError](https://vuejs.org/v2/api/#renderError)       | <b class="tag-yes">Yes</b> | - |
+| [directives](https://vuejs.org/v2/api/#directives)         | <b class="tag-yes">Yes</b> | - |
+| [filters](https://vuejs.org/v2/api/#filters)               | <b class="tag-yes">Yes</b> | - |
+| [components](https://vuejs.org/v2/api/#components)         | <b class="tag-yes">Yes</b> | - |
+| [parent](https://vuejs.org/v2/api/#parent)                 | <b class="tag-yes">Yes</b> | Not Recommended. |
+| [mixins](https://vuejs.org/v2/api/#mixins)                 | <b class="tag-yes">Yes</b> | - |
+| [extends](https://vuejs.org/v2/api/#extends)               | <b class="tag-yes">Yes</b> | - |
+| [provide/inject](https://vuejs.org/v2/api/#provide-inject) | <b class="tag-yes">Yes</b> | Not Recommended. |
+| [name](https://vuejs.org/v2/api/#name)                     | <b class="tag-yes">Yes</b> | - |
+| [delimiters](https://vuejs.org/v2/api/#delimiters)         | <b class="tag-yes">Yes</b> | Not Recommended. |
+| [functional](https://vuejs.org/v2/api/#functional)         | <b class="tag-yes">Yes</b> | - |
+| [model](https://vuejs.org/v2/api/#model)                   | <b class="tag-yes">Yes</b> | - |
+| [inheritAttrs](https://vuejs.org/v2/api/#inheritAttrs)     | <b class="tag-yes">Yes</b> | - |
+| [comments](https://vuejs.org/v2/api/#comments)             | <b class="tag-no">No</b>   | - |
+
+### Lifecycle Hooks
+
+Instance lifecycle hooks of Vue components will be emitted at particular stages, refer to the [lifecycle diagram](https://vuejs.org/v2/guide/instance.html#Lifecycle-Diagram) of Vue component for more details.
+
+| Vue Lifecycle Hook | Supported | Notes |
+| ------------------ | --------- | ----- |
+| [beforeCreate](https://vuejs.org/v2/api/#beforeCreate)   | <b class="tag-yes">Yes</b> | - |
+| [created](https://vuejs.org/v2/api/#created)             | <b class="tag-yes">Yes</b> | - |
+| [beforeMount](https://vuejs.org/v2/api/#beforeMount)     | <b class="tag-yes">Yes</b> | - |
+| [mounted](https://vuejs.org/v2/api/#mounted)             | <b class="tag-yes">Yes</b> | Not exactly the same with web. |
+| [beforeUpdate](https://vuejs.org/v2/api/#beforeUpdate)   | <b class="tag-yes">Yes</b> | - |
+| [updated](https://vuejs.org/v2/api/#updated)             | <b class="tag-yes">Yes</b> | - |
+| [activated](https://vuejs.org/v2/api/#activated)         | <b class="tag-no">No</b>   | Not support `<keep-alive>` yet. |
+| [deactivated](https://vuejs.org/v2/api/#deactivated)     | <b class="tag-no">No</b>   | Not support `<keep-alive>` yet. |
+| [beforeDestroy](https://vuejs.org/v2/api/#beforeDestroy) | <b class="tag-yes">Yes</b> | - |
+| [destroyed](https://vuejs.org/v2/api/#destroyed)         | <b class="tag-yes">Yes</b> | - |
+| [errorCaptured](https://vuejs.org/v2/api/#errorCaptured) | <b class="tag-yes">Yes</b> | New in Vue 2.5.0+, Weex SDK 0.18+ |
+
+### Instance Properties
+
+| Vue Instance Property | Supported | Notes |
+| --------------------- | --------- | ----- |
+| [vm.$data](https://vuejs.org/v2/api/#vm-data)               | <b class="tag-yes">Yes</b> | - |
+| [vm.$props](https://vuejs.org/v2/api/#vm-props)             | <b class="tag-yes">Yes</b> | - |
+| [vm.$el](https://vuejs.org/v2/api/#vm-el)                   | <b class="tag-yes">Yes</b> | The value is not `HTMLElement` on the mobile. |
+| [vm.$options](https://vuejs.org/v2/api/#vm-options)         | <b class="tag-yes">Yes</b> | - |
+| [vm.$parent](https://vuejs.org/v2/api/#vm-parent)           | <b class="tag-yes">Yes</b> | - |
+| [vm.$root](https://vuejs.org/v2/api/#vm-root)               | <b class="tag-yes">Yes</b> | - |
+| [vm.$children](https://vuejs.org/v2/api/#vm-children)       | <b class="tag-yes">Yes</b> | - |
+| [vm.$slots](https://vuejs.org/v2/api/#vm-slots)             | <b class="tag-yes">Yes</b> | - |
+| [vm.$scopedSlots](https://vuejs.org/v2/api/#vm-scopedSlots) | <b class="tag-yes">Yes</b> | - |
+| [vm.$refs](https://vuejs.org/v2/api/#vm-refs)               | <b class="tag-yes">Yes</b> | - |
+| [vm.$isServer](https://vuejs.org/v2/api/#vm-isServer)       | <b class="tag-yes">Yes</b> | Always `false`. |
+| [vm.$attrs](https://vuejs.org/v2/api/#vm-attrs)             | <b class="tag-yes">Yes</b> | - |
+| [vm.$listeners](https://vuejs.org/v2/api/#vm-listeners)     | <b class="tag-yes">Yes</b> | - |
+
+### Instance Methods
+
+| Vue Instance Method | Supported | Notes |
+| ------------------- | --------- | ----- |
+| [vm.$watch()](https://vuejs.org/v2/api/#vm-watch)             | <b class="tag-yes">Yes</b> | - |
+| [vm.$set()](https://vuejs.org/v2/api/#vm-set)                 | <b class="tag-yes">Yes</b> | - |
+| [vm.$delete()](https://vuejs.org/v2/api/#vm-delete)           | <b class="tag-yes">Yes</b> | - |
+| [vm.$on()](https://vuejs.org/v2/api/#vm-on)                   | <b class="tag-yes">Yes</b> | - |
+| [vm.$once()](https://vuejs.org/v2/api/#vm-once)               | <b class="tag-yes">Yes</b> | - |
+| [vm.$off()](https://vuejs.org/v2/api/#vm-off)                 | <b class="tag-yes">Yes</b> | - |
+| [vm.$emit()](https://vuejs.org/v2/api/#vm-emit)               | <b class="tag-yes">Yes</b> | - |
+| [vm.$mount()](https://vuejs.org/v2/api/#vm-mount)             | <b class="tag-no">No</b>   | You don't need to mount Vue instance manually. |
+| [vm.$forceUpdate()](https://vuejs.org/v2/api/#vm-forceUpdate) | <b class="tag-yes">Yes</b> | - |
+| [vm.$nextTick()](https://vuejs.org/v2/api/#vm-nextTick)       | <b class="tag-yes">Yes</b> | - |
+| [vm.$destroy()](https://vuejs.org/v2/api/#vm-destroy)         | <b class="tag-yes">Yes</b> | - |
+
+### Directives
+
+| Vue Directive | Supported | Notes |
+| ------------- | --------- | ----- |
+| [v-text](https://vuejs.org/v2/api/#v-text)       | <b class="tag-yes">Yes</b> | - |
+| [v-html](https://vuejs.org/v2/api/#v-html)       | <b class="tag-no">No</b>   | No HTML parser in Weex, and it is not good practice. |
+| [v-show](https://vuejs.org/v2/api/#v-show)       | <b class="tag-no">No</b>   | Not support `display: none;` yet. |
+| [v-if](https://vuejs.org/v2/api/#v-if)           | <b class="tag-yes">Yes</b> | - |
+| [v-else](https://vuejs.org/v2/api/#v-else)       | <b class="tag-yes">Yes</b> | - |
+| [v-else-if](https://vuejs.org/v2/api/#v-else-if) | <b class="tag-yes">Yes</b> | - |
+| [v-for](https://vuejs.org/v2/api/#v-for)         | <b class="tag-yes">Yes</b> | - |
+| [v-on](https://vuejs.org/v2/api/#v-on)           | <b class="tag-yes">Yes</b> | - |
+| [v-bind](https://vuejs.org/v2/api/#v-bind)       | <b class="tag-yes">Yes</b> | - |
+| [v-model](https://vuejs.org/v2/api/#v-model)     | <b class="tag-yes">Yes</b> | - |
+| [v-pre](https://vuejs.org/v2/api/#v-pre)         | <b class="tag-yes">Yes</b> | - |
+| [v-cloak](https://vuejs.org/v2/api/#v-cloak)     | <b class="tag-no">No</b>   | Only support single class selector. |
+| [v-once](https://vuejs.org/v2/api/#v-once)       | <b class="tag-yes">Yes</b> | - |
+
+### Special Attributes
+
+| Vue Special Attribute | Supported | Notes |
+| --------------------- | --------- | ----- |
+| [key](https://vuejs.org/v2/api/#key)               | <b class="tag-yes">Yes</b> | - |
+| [ref](https://vuejs.org/v2/api/#ref)               | <b class="tag-yes">Yes</b> | - |
+| [slot](https://vuejs.org/v2/api/#slot)             | <b class="tag-yes">Yes</b> | - |
+| [slot-scope](https://vuejs.org/v2/api/#slot-scope) | <b class="tag-yes">Yes</b> | New in Vue 2.5.0+, Weex SDK 0.18+ |
+| [scope](https://vuejs.org/v2/api/#scope)           | <b class="tag-yes">Yes</b> | Not Recommended. |
+| [is](https://vuejs.org/v2/api/#is)                 | <b class="tag-yes">Yes</b> | - |
+
+### Built-In Components
+
+| Vue Built-In Component | Supported | Notes |
+| ---------------------- | --------- | ----- |
+| [component](https://vuejs.org/v2/api/#component)               | <b class="tag-yes">Yes</b> | - |
+| [transition](https://vuejs.org/v2/api/#transition)             | <b class="tag-no">No</b>   | The concept of *enter* and *leave* maybe different on the mobile, and Weex does not support `display: none;` yet. |
+| [transition-group](https://vuejs.org/v2/api/#transition-group) | <b class="tag-no">No</b>   | Same with *transition*. |
+| [keep-alive](https://vuejs.org/v2/api/#keep-alive)             | <b class="tag-no">No</b>   | Native components on the mobile can not be cached at front-end. |
+| [slot](https://vuejs.org/v2/api/#slot)                         | <b class="tag-yes">Yes</b> | - |