You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@weex.apache.org by cn...@apache.org on 2020/07/14 12:39:48 UTC
[incubator-weex-ui] branch master updated: [!] English
documentation fixes
This is an automated email from the ASF dual-hosted git repository.
cnryb pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/incubator-weex-ui.git
The following commit(s) were added to refs/heads/master by this push:
new 927d825 [!] English documentation fixes
new c233792 Merge pull request #501 from joyhchen/docs-improvement
927d825 is described below
commit 927d825ed379747040397c284cbc746cd35d9c48
Author: Joy Chen <jh...@cornell.edu>
AuthorDate: Fri Jul 10 09:25:35 2020 -0500
[!] English documentation fixes
---
README.md | 10 +++++-----
docs/faq.md | 10 +++++-----
docs/with-weex-toolkit.md | 2 +-
packages/wxc-tab-bar/README.md | 2 +-
4 files changed, 12 insertions(+), 12 deletions(-)
diff --git a/README.md b/README.md
index bbfca0e..faeadc6 100644
--- a/README.md
+++ b/README.md
@@ -23,7 +23,7 @@
<img src="https://img.alicdn.com/tfs/TB1O2ulhgoQMeJjy0FoXXcShVXa-1282-986.jpg" width=540/>
-Try [**it**](https://h5.m.taobao.com/trip/weex-ui/index.html?_wx_tpl=https%3A%2F%2Fh5.m.taobao.com%2Ftrip%2Fweex-ui%2Fdemo%2Findex.native-min.js) with Fliggy、Taobao、Tmall、Weex Playground or any browsers now!
+Try [**it**](https://h5.m.taobao.com/trip/weex-ui/index.html?_wx_tpl=https%3A%2F%2Fh5.m.taobao.com%2Ftrip%2Fweex-ui%2Fdemo%2Findex.native-min.js) with Fliggy, Taobao, Tmall, Weex Playground or any browsers now!
## Installation
@@ -72,7 +72,7 @@ npm i weex-ui -S
### Before use
In order to not pack all the components, you need to use [`babel-plugin-component`](https://www.npmjs.com/package/babel-plugin-component) to import the specified component.
-At the same time, if you haven't installed `babel-preset-stage-0`, its necessary to install it.
+At the same time, if you haven't installed `babel-preset-stage-0`, it's necessary to install it.
```shell
npm i babel-preset-stage-0 babel-plugin-component -D
@@ -96,10 +96,10 @@ npm i babel-preset-stage-0 babel-plugin-component -D
### More
-* If babel-loader in `webpack.config.js` has a exclude for node_modules, please turn on for week-ui as `exclude: /node_modules(?!(\/|\\).*(weex).*)/`.
+* If babel-loader in `webpack.config.js` has a exclude for node_modules, please turn on for weex-ui as `exclude: /node_modules(?!(\/|\\).*(weex).*)/`.
* In order to get the latest features, please focus on the [ChangeLog](https://github.com/apache/incubator-weex-ui/releases) and often update `weex-ui` to the latest.
-* Many questions can be found from [faq](https://apache.github.io/incubator-weex-ui/#/faq) and [issue list](https://github.com/apache/incubator-weex-ui/issues?utf8=%E2%9C%93&q=), if you find a new bug, just file a [issue](https://github.com/apache/incubator-weex-ui/issues/new).
-* More experience in Weex construction can be learned from [Weex + Ui - Weex Conf 2018](https://apache.github.io/incubator-weex-ui/#/docs/weex-ui-weex-conf-2018) ,welcome to translate it.
+* Many questions can be found in the [faq](https://apache.github.io/incubator-weex-ui/#/docs/faq) and [issue list](https://github.com/apache/incubator-weex-ui/issues?utf8=%E2%9C%93&q=), if you find a new bug, just file an [issue](https://github.com/apache/incubator-weex-ui/issues/new).
+* More experience in Weex construction can be learned from [Weex + Ui - Weex Conf 2018](https://apache.github.io/incubator-weex-ui/#/docs/weex-ui-weex-conf-2018), welcome to translate it.
## Development
diff --git a/docs/faq.md b/docs/faq.md
index ed7fcf1..2fc88de 100644
--- a/docs/faq.md
+++ b/docs/faq.md
@@ -1,12 +1,12 @@
## FAQ
-#### wxc-ep-slider、wxc-slider-bar Can't slide
+#### wxc-ep-slider, wxc-slider-bar Can't slide
- The two components in Weex Ui now depend on an innovative interaction feature called [BindingX](https://alibaba.github.io/bindingx/), And this feature is already open source, please refer to github [to import](https://github.com/alibaba/bindingx#installation).
#### Suggestions for using images in Weex.
- Use CDN image：It is recommended to use, and to ensure that the actual size and size of the image is consistent with what you need to show.
-- Use local image：Weex’s native runtime support load image file from device’s disk, all you have to do set the file url like file:///sdcard/image_new0.png,More you can see [here](http://blog.csdn.net/codingfire/article/details/79528639), At the same time, Weex does not support the loading of image files in your project, nor does it support the direct use of local images by downgrade Web version. Therefore, it is recommended to use the CDN image link.
+- Use local image：Weex’s native runtime support load image file from device’s disk, all you have to do set the file url like file:///sdcard/image_new0.png. See more [here](http://blog.csdn.net/codingfire/article/details/79528639). At the same time, Weex does not support the loading of image files in your project, nor does it support the direct use of local images by downgrade Web version. Therefore, it is recommended to use the CDN image link.
- Use Base64：This depends on native image library resolution, but it is not recommended to use more than 2k Base64 in Weex, which makes the bundle too large to affect performance.
#### Module not found: Error: Can't resolve 'weex-ui/packages/wxc-button/style.css'
@@ -32,14 +32,14 @@
```
#### vue.runtime.js:478 [Vue warn]: Cannot find element: #root
-- The default config of weex project create by weex-toolkit will generate entry config automatically, but this project has already used entry.js as entry config in webpack,Details of the cause are visible in [pull/21](https://github.com/zwwill/yanxuan-weex-demo/pull/21).
+- The default config of weex project created by weex-toolkit will generate entry config automatically, but this project has already used entry.js as entry config in webpack. Details of the cause are visible in [pull/21](https://github.com/zwwill/yanxuan-weex-demo/pull/21).
#### GIF images have no animation on Android
- This is supported by the underlying image library, More you can refer to [Weex 踩坑之 Gif 加载](https://zhoukekestar.github.io/notes/2017/07/17/weex-gif.html).
#### Does Weex Ui support the horizontal screen ？
-- I'm sorry,Now Weex doesn't support horizontal screen, so Weex Ui doesn't have any horizontal screen mode yet. When Weex supports it, it will follow immediately.
+- I'm sorry, Weex currently doesn't support horizontal screen, so Weex Ui doesn't have any horizontal screen mode yet. When Weex supports it, it will follow immediately.
- You can send a message to weex at the horizontal screen, Then handle this in your code.
```js
@@ -104,4 +104,4 @@
```
----
-More questions can be found from the [issue list](https://github.com/apache/incubator-weex-ui/issues?utf8=%E2%9C%93&q=), If you find a new bug, Just file a [issue](https://github.com/apache/incubator-weex-ui/issues/new).
+More questions can be found from the [issue list](https://github.com/apache/incubator-weex-ui/issues?utf8=%E2%9C%93&q=). If you find a new bug, Just file an [issue](https://github.com/apache/incubator-weex-ui/issues/new).
diff --git a/docs/with-weex-toolkit.md b/docs/with-weex-toolkit.md
index 4664795..e1b5dda 100644
--- a/docs/with-weex-toolkit.md
+++ b/docs/with-weex-toolkit.md
@@ -2,7 +2,7 @@
### Before installing
-Before installing, It`s recommended that your Node version >= 8.0, Also recommended to use [n](https://github.com/tj/n) for version management, while suggesting NPM version >= 5
+Before installing, It's recommended that your Node version >= 8.0, Also recommended to use [n](https://github.com/tj/n) for version management. We also suggest NPM version >= 5
How to see
diff --git a/packages/wxc-tab-bar/README.md b/packages/wxc-tab-bar/README.md
index 61ff1c3..8f69802 100644
--- a/packages/wxc-tab-bar/README.md
+++ b/packages/wxc-tab-bar/README.md
@@ -3,7 +3,7 @@
> Bottom tab bar
### Rule
-- For the bottom Tab slider page, currently support **icon 、text 、iconFont ** form of the bottom bar.
+- For the bottom Tab slider page, currently support **icon, text, iconFont ** form of the bottom bar.
## [Demo](https://h5.m.taobao.com/trip/wx-detection-demo/tab-bar/index.html?_wx_tpl=https%3A%2F%2Fh5.m.taobao.com%2Ftrip%2Fwx-detection-demo%2Ftab-bar%2Findex.weex.js)