From 56429ad4e181aa1e0695ef609006d64b62f76978 Mon Sep 17 00:00:00 2001 From: dengrongyao Date: Wed, 7 Apr 2021 20:17:35 +0800 Subject: [PATCH] =?UTF-8?q?docs:=20=E8=B0=83=E6=95=B4=E7=BB=84=E4=BB=B6?= =?UTF-8?q?=E4=BB=8B=E7=BB=8D=E6=96=87=E6=A1=A3?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- src/area/README.md | 2 +- src/badge/README.md | 2 +- src/cascader/README.md | 2 +- src/checkbox/README.md | 2 +- src/checkbox/README.zh-CN.md | 2 +- src/circle/README.md | 2 +- src/count-down/README.md | 2 +- src/dialog/README.md | 2 +- src/dialog/README.zh-CN.md | 4 +--- src/divider/README.md | 2 +- src/field/README.md | 2 +- src/field/README.zh-CN.md | 2 +- src/form/README.md | 2 +- src/icon/README.md | 2 +- src/image/README.md | 2 +- src/index-bar/README.md | 2 +- src/notice-bar/README.md | 2 +- src/number-keyboard/README.md | 2 +- src/password-input/README.md | 2 +- src/picker/README.md | 2 +- src/popover/README.md | 2 +- src/popup/README.md | 2 +- src/radio/README.md | 2 +- src/radio/README.zh-CN.md | 2 +- src/rate/README.md | 2 +- src/search/README.md | 2 +- src/share-sheet/README.md | 2 +- src/slider/README.md | 2 +- src/stepper/README.md | 2 +- src/steps/README.md | 2 +- src/sticky/README.md | 2 +- src/tabbar/README.md | 2 +- src/toast/README.md | 2 +- src/uploader/README.md | 2 +- 34 files changed, 34 insertions(+), 36 deletions(-) diff --git a/src/area/README.md b/src/area/README.md index 4c38b2646..186243769 100644 --- a/src/area/README.md +++ b/src/area/README.md @@ -2,7 +2,7 @@ ### Intro -The Picker component is usually used with [Popup](#/en-US/popup) Component. +A three-level linkage selection of provinces and cities, usually used in conjunction with [Popup](#/en-US/popup) component. ### Install diff --git a/src/badge/README.md b/src/badge/README.md index e69a1d3e3..f5b6d9d9c 100644 --- a/src/badge/README.md +++ b/src/badge/README.md @@ -2,7 +2,7 @@ ### Intro -Display the logo number or small red dot in the upper right corner. +Display a small badge or a red dot to the top-right of its child. ### Install diff --git a/src/cascader/README.md b/src/cascader/README.md index 99da34f4d..1cc75cbac 100644 --- a/src/cascader/README.md +++ b/src/cascader/README.md @@ -2,7 +2,7 @@ ### Intro -The cascading selection box is used for the selection of multi-level data. The typical scene is the selection of provinces and cities. +The cascader component is used for the selection of multi-level data. The typical scene is the selection of provinces and cities. ### Install diff --git a/src/checkbox/README.md b/src/checkbox/README.md index cf1eac562..6b8b63b40 100644 --- a/src/checkbox/README.md +++ b/src/checkbox/README.md @@ -2,7 +2,7 @@ ### Intro -Used to switch between selected and unselected states. +A group of options for multiple choices. ### Install diff --git a/src/checkbox/README.zh-CN.md b/src/checkbox/README.zh-CN.md index 7a1aa8509..1831d64c0 100644 --- a/src/checkbox/README.zh-CN.md +++ b/src/checkbox/README.zh-CN.md @@ -2,7 +2,7 @@ ### 介绍 -用于在选中和非选中状态之间进行切换。 +在一组备选项中进行多选。 ### 引入 diff --git a/src/circle/README.md b/src/circle/README.md index a4aff9eb2..43326ec48 100644 --- a/src/circle/README.md +++ b/src/circle/README.md @@ -2,7 +2,7 @@ ### Intro -The circular progress bar component supports the gradient animation of the progress. +Circular progress bar component, and supports gradient color animation. ### Install diff --git a/src/count-down/README.md b/src/count-down/README.md index 22f350223..5c794bb8d 100644 --- a/src/count-down/README.md +++ b/src/count-down/README.md @@ -2,7 +2,7 @@ ### Intro -It is used to display the countdown value in real time, and the accuracy supports milliseconds. +Used to display the countdown value in real time, and precision supports milliseconds. ### Install diff --git a/src/dialog/README.md b/src/dialog/README.md index c8a567f7e..a49bee8c4 100644 --- a/src/dialog/README.md +++ b/src/dialog/README.md @@ -2,7 +2,7 @@ ### Intro -Pop-up modal boxes are often used for message prompts, message confirmations, or to complete specific interactive operations in the current page. The Dialog component supports two methods: function call and component call. +A modal box pops up on the page, which is often used for message prompts, message confirmation, or to complete specific interactive operations in the current page. It supports two methods: function call and component call. ### Install diff --git a/src/dialog/README.zh-CN.md b/src/dialog/README.zh-CN.md index 96817ba66..ffec46637 100644 --- a/src/dialog/README.zh-CN.md +++ b/src/dialog/README.zh-CN.md @@ -2,9 +2,7 @@ ### 介绍 -弹出模态框，常用于消息提示、消息确认，或在当前页面内完成特定的交互操作。 - -弹出框组件支持函数调用和组件调用两种方式。 +弹出模态框，常用于消息提示、消息确认，或在当前页面内完成特定的交互操作，支持函数调用和组件调用两种方式。 ### 函数调用 diff --git a/src/divider/README.md b/src/divider/README.md index 9f6210623..c44debeb5 100644 --- a/src/divider/README.md +++ b/src/divider/README.md @@ -2,7 +2,7 @@ ### Intro -Used to divide content into multiple areas. +Separate content into multiple areas. ### Install diff --git a/src/field/README.md b/src/field/README.md index fef808cc0..f9e28c044 100644 --- a/src/field/README.md +++ b/src/field/README.md @@ -2,7 +2,7 @@ ### Intro -The input box component in the form. +Field component let users enter and edit text. ### Install diff --git a/src/field/README.zh-CN.md b/src/field/README.zh-CN.md index b689c3d56..056d229e3 100644 --- a/src/field/README.zh-CN.md +++ b/src/field/README.zh-CN.md @@ -2,7 +2,7 @@ ### 介绍 -表单中的输入框组件。 +用户可以在文本框内输入或编辑文字。 ### 引入 diff --git a/src/form/README.md b/src/form/README.md index ee1a73a44..eaced3611 100644 --- a/src/form/README.md +++ b/src/form/README.md @@ -2,7 +2,7 @@ ### Intro -It is used for data entry and verification, and supports input boxes, radio buttons, check boxes, file uploads and other types. +Used for data entry and verification, and supports input boxes, radio buttons, check boxes, file uploads and other types. ### Install diff --git a/src/icon/README.md b/src/icon/README.md index 81650e9ec..bf47e3bb5 100644 --- a/src/icon/README.md +++ b/src/icon/README.md @@ -2,7 +2,7 @@ ### Intro -The font-based icon set can be used through the Icon component or referenced in other components through the `icon` property. +The font-based icon set that can be used via the Icon component or referenced in other components via the `icon` attribute. ### Install diff --git a/src/image/README.md b/src/image/README.md index 7f3824d7a..961791c46 100644 --- a/src/image/README.md +++ b/src/image/README.md @@ -2,7 +2,7 @@ ### Intro -This is an enhanced version of the img tag, which provides multiple image filling modes, supports lazy loading of images, prompts during loading, and prompts for loading failures. +Enhanced img tag with multiple image fill modes, support for image lazy loading, loading hint, loading failure hint. ### Install diff --git a/src/index-bar/README.md b/src/index-bar/README.md index bfcc7bde6..3d6722a4c 100644 --- a/src/index-bar/README.md +++ b/src/index-bar/README.md @@ -2,7 +2,7 @@ ### Intro -Used for the index classification display and quick positioning of the list. +Used for indexed sorting display and quick positioning of lists. ### Install diff --git a/src/notice-bar/README.md b/src/notice-bar/README.md index 8f29916fe..564d895c7 100644 --- a/src/notice-bar/README.md +++ b/src/notice-bar/README.md @@ -2,7 +2,7 @@ ### Intro -Used to display a group of message notifications in a loop. +Used to display a group of message notifications in a continuons loop. ### Install diff --git a/src/number-keyboard/README.md b/src/number-keyboard/README.md index 802ff04ee..2f833fdde 100644 --- a/src/number-keyboard/README.md +++ b/src/number-keyboard/README.md @@ -2,7 +2,7 @@ ### Intro -The pseudo-numeric keyboard can be used with [PasswordInput](#/en-US/password-input) components or custom input box components. +The numberkeyboard component can be used with [PasswordInput](#/en-US/password-input) components or custom input box components. ### Install diff --git a/src/password-input/README.md b/src/password-input/README.md index 8e3b453bb..a0000dd49 100644 --- a/src/password-input/README.md +++ b/src/password-input/README.md @@ -2,7 +2,7 @@ ### Intro -The PasswordInput component is usually used with [NumberKeyboard](#/en-US/number-keyboard) Component. +The passwordinput component is usually used with [NumberKeyboard](#/en-US/number-keyboard) Component. ### Install diff --git a/src/picker/README.md b/src/picker/README.md index c20324570..b15c39a5e 100644 --- a/src/picker/README.md +++ b/src/picker/README.md @@ -2,7 +2,7 @@ ### Intro -The Picker component is usually used with [Popup](#/en-US/popup) Component. +The picker component is usually used with [Popup](#/en-US/popup) Component. ### Install diff --git a/src/popover/README.md b/src/popover/README.md index 54dcfa392..73949c501 100644 --- a/src/popover/README.md +++ b/src/popover/README.md @@ -2,7 +2,7 @@ ### Intro -Pop-up bubble menu. +Used to display some content on top of another. ### Install diff --git a/src/popup/README.md b/src/popup/README.md index 18a356ff0..8879ce88d 100644 --- a/src/popup/README.md +++ b/src/popup/README.md @@ -2,7 +2,7 @@ ### Intro -The pop-up layer container is used to display pop-up windows, information prompts, etc., and supports multiple pop-up layers to display. +Used to display pop-up windows, information prompts, etc., and supports multiple pop-up layers to display. ### Install diff --git a/src/radio/README.md b/src/radio/README.md index fad88266a..00f6fc7e4 100644 --- a/src/radio/README.md +++ b/src/radio/README.md @@ -2,7 +2,7 @@ ### Intro -Used to select a single result among multiple options. +Single selection among multiple options. ### Install diff --git a/src/radio/README.zh-CN.md b/src/radio/README.zh-CN.md index 007f04aa8..40cc74fcf 100644 --- a/src/radio/README.zh-CN.md +++ b/src/radio/README.zh-CN.md @@ -2,7 +2,7 @@ ### 介绍 -用于在多个选项中选择单个结果。 +在一组备选项中进行单选。 ### 引入 diff --git a/src/rate/README.md b/src/rate/README.md index 7845e6362..b4da9466d 100644 --- a/src/rate/README.md +++ b/src/rate/README.md @@ -2,7 +2,7 @@ ### Intro -Used for rating things. +The rate component is used for rating things. ### Install diff --git a/src/search/README.md b/src/search/README.md index 2c645a915..b4e5dc19f 100644 --- a/src/search/README.md +++ b/src/search/README.md @@ -2,7 +2,7 @@ ### Intro -The input box component used for searching. +Input box component for search scenarios. ### Install diff --git a/src/share-sheet/README.md b/src/share-sheet/README.md index 10292a390..672b7371c 100644 --- a/src/share-sheet/README.md +++ b/src/share-sheet/README.md @@ -2,7 +2,7 @@ ### Intro -The sharing panel that pops up at the bottom is used to display the operation buttons corresponding to each sharing channel, and does not include specific sharing logic. +A pop-up sharing panel at the bottom for displaying the action buttons corresponding to each sharing channel, without specific sharing logic. ### Install diff --git a/src/slider/README.md b/src/slider/README.md index be9427330..1ed7ba615 100644 --- a/src/slider/README.md +++ b/src/slider/README.md @@ -2,7 +2,7 @@ ### Intro -Slide the input bar to select a value within a given range. +Used to select a value within a given range. ### Install diff --git a/src/stepper/README.md b/src/stepper/README.md index eaefcf482..0d45ffcab 100644 --- a/src/stepper/README.md +++ b/src/stepper/README.md @@ -2,7 +2,7 @@ ### Intro -The stepper consists of an increase button, a decrease button and an input box, which are used to input or adjust numbers within a certain range. +The stepper component consists of an increase button, a decrease button and an input box, which are used to input and adjust numbers within a certain range. ### Install diff --git a/src/steps/README.md b/src/steps/README.md index 53d2a8177..5782f86e1 100644 --- a/src/steps/README.md +++ b/src/steps/README.md @@ -2,7 +2,7 @@ ### Intro -Used to show each link of the operation process and let users understand the position of the current operation in the overall process. +Used to show the various parts of the action flow and let the user know where the current action fits into the overall flow. ### Install diff --git a/src/sticky/README.md b/src/sticky/README.md index ead6150bc..9fd461dde 100644 --- a/src/sticky/README.md +++ b/src/sticky/README.md @@ -2,7 +2,7 @@ ### Intro -The Sticky component has the same effect as the `position: sticky` property in CSS. When the component is within the screen range, it will be arranged according to the normal layout. When the component rolls out of the screen, it will always be fixed at the top of the screen. +The sticky component is consistent with the effect achieved by the `position: sticky` property in CSS, in that when the component is within screen range, it will follow the normal layout arrangement, and when the component rolls out of screen range, it will always be fixed at the top of the screen. ### Install diff --git a/src/tabbar/README.md b/src/tabbar/README.md index 37de2b8bc..dd9567d46 100644 --- a/src/tabbar/README.md +++ b/src/tabbar/README.md @@ -2,7 +2,7 @@ ### Intro -The bottom navigation bar is used to switch between different pages. +Used to switch between different pages. ### Install diff --git a/src/toast/README.md b/src/toast/README.md index b65f247d1..93dc7be2f 100644 --- a/src/toast/README.md +++ b/src/toast/README.md @@ -2,7 +2,7 @@ ### Intro -A black translucent prompt pops up in the middle of the page, which is used in scenarios such as message notification, loading prompt, and operation result prompt. +Black semi-transparent pop-up hint in the middle of the page, used for message notification, loading hint, operation result hint and other scenarios. ### Install diff --git a/src/uploader/README.md b/src/uploader/README.md index 41ca7fd73..8e85f90f0 100644 --- a/src/uploader/README.md +++ b/src/uploader/README.md @@ -2,7 +2,7 @@ ### Intro -Used to upload local pictures or files to the server, and display preview images and upload progress during the upload process. Currently, the Uploader component does not contain the interface logic for uploading files to the server. This step needs to be implemented by yourself. +Used to upload a local image or file to the server and display a preview image and upload progress during the upload process. The Uploader component does not currently contain the interface logic for uploading files to the server, this step needs to be implemented by the user. ### Install