docs: add english document #17
Conversation
|
This pull request is being automatically deployed with Vercel (learn more). 🔍 Inspect: https://vercel.com/ecomfe/veui-docs/GoNNJ9h35XGEuKTb7TtnrWa34Zhq |
|
加入了 |
|
发现了 |
|
@xiaoxunyao 非常感谢！我会抽时间 review 这个 PR。我们可以提前做一些约定：
另外，npm 无法安装的问题是否因为版本问题？是不是可以尝试升级一下 npm 再安装一下？ |
|
@Justineo 好的，没有任何问题，我会遵守这些约定。 |
|
npm的问题我昨天找到了，因为我的学校有一些网址无法打开，所以我一般挂了VPN，然后就有一些包无法下载，我使用流量就没有任何问题了。 |
|
增加了 |
|
根据刚刚修改的地方，稍微自查了一下. |
|
增加了 希望检查这个的时候我不会太打脸，先立个 flag 再说。 |
|
|
||
| ## Demos | ||
|
|
||
| ### Size |
There was a problem hiding this comment.
| ### Size | |
| ### Size variants |
|
|
||
| ### Size | ||
|
|
||
| Available size variants for the ui prop: `s` / `m`. |
There was a problem hiding this comment.
| Available size variants for the ui prop: `s` / `m`. | |
| Available size variants for the [`ui`](#props-ui) prop: `s` / `m`. |
|
建议可以用 DeepL 做初步的机翻，效果其实还不错的，然后做些细节调整就可以了。 |
|
行吧，初步用了Google然后自己改了改……主要是第二次写的时候发现好多不会…… |
|
我再去改改其他的，我跟英语杠上了，我还不信能让他给我憋死！ |
|
慢慢来哈，这也不完全是英语的问题，我有些调整了一下是为了和之前其他部分翻译成英文的部分保持一致。中文文档也不是一个人写的，有些表达的确本身也有点问题。 |
one/docs/en-US/components/badge.md
Outdated
|
|
||
| [[ demo src="/demo/badge/text.vue" ]] | ||
|
|
||
| ### Digital badge |
There was a problem hiding this comment.
| ### Digital badge | |
| ### Numeric badge |
one/docs/en-US/components/badge.md
Outdated
|
|
||
| ### Digital badge | ||
|
|
||
| Badge content can be number, When the maximum value is exceeded, it can be displayed as *Maximum+*. |
There was a problem hiding this comment.
| Badge content can be number, When the maximum value is exceeded, it can be displayed as *Maximum+*. | |
| The content can also be a number and can be can be displayed as “<var>max</var>+” when exceeding the maximum value. |
one/docs/en-US/components/badge.md
Outdated
|
|
||
| [[ demo src="/demo/badge/number.vue" ]] | ||
|
|
||
| ### Round Dots badge |
There was a problem hiding this comment.
这里好像原文写错了，应该是飘角徽标，这里写 Corner badge 吧
one/docs/en-US/components/badge.md
Outdated
|
|
||
| ### Round Dots badge | ||
|
|
||
| No badge content is provided, The badge will be displayed in a dot style in the upper right corner. |
There was a problem hiding this comment.
| No badge content is provided, The badge will be displayed in a dot style in the upper right corner. | |
| When no badge content is provided, the badge will be displayed in the upper right corner in a dot style. |
| No badge content is provided, The badge will be displayed in a dot style in the upper right corner. | ||
|
|
||
| [[ demo src="/demo/badge/corner-dot.vue" ]] | ||
|
|
| | ``input`` | Triggered when a search keyword is entered. The callback parameter is `(value: string)`, and `value` is the `value` value of the input box. | | ||
| | ``select`` | [^event-select] | | ||
| | ``afteropen`` | Fired when the drop-down menu is turned on. | | ||
| | ``afterclose`` | Fired when the drop-down menu is turned off. | |
There was a problem hiding this comment.
| | ``afterclose`` | Fired when the drop-down menu is turned off. | | |
| | ``afterclose`` | Triggered after the dropdown panel is collapsed. | |
| `v-model` | ||
| ::: | ||
|
|
||
| Triggered after the selected state changes, the callback parameter is `(value: *)`. `value` is the value of the currently selected `value` field. |
There was a problem hiding this comment.
| Triggered after the selected state changes, the callback parameter is `(value: *)`. `value` is the value of the currently selected `value` field. | |
| Triggered after the selected state changes, the callback parameter is `(value: *)`. `value` is the value of the currently selected option value. |
| Triggered after the selected state changes, the callback parameter is `(value: *)`. `value` is the value of the currently selected `value` field. | ||
| ^^^ | ||
|
|
||
| ### Global config |
There was a problem hiding this comment.
| ### Global config | |
| ### Global configs |
| | ``cascader.placeholder`` | `string` | `@@cascader.placeholder` | Placeholder content when not selected. | | ||
|
|
||
| :::tip | ||
| A value starting with `@@` refers to the relevant field in the multilingual config. |
There was a problem hiding this comment.
| A value starting with `@@` refers to the relevant field in the multilingual config. | |
| `@@` prefixed values denote corresponding properties in the locale settings. |
| A value starting with `@@` refers to the relevant field in the multilingual config. | ||
| ::: | ||
|
|
||
| ### Icon |
There was a problem hiding this comment.
| ### Icon | |
| ### Icons |
Justineo
force-pushed
the
master
branch
3 times, most recently
from
2c93255 to
6e4c33f
Compare
描述
在
one/docs/development/en-US/components中增加了accordion.md文件，并且在nav.json中将禁用取消，由于是第一次编写文档，按照了中文文档的风格进行编写，如有不好的麻烦您进行指出，我会及时查阅书本进行修正。相关问题
无
动机和背景
@Justineo 您好，昨天在 twitter 上看到了您的项目，发现您在评论中回答暂时没有足够的人力来进行英文文档的编写，我最近在苦练英文，想通过您的
veui的英文文档来加强自己的英文写作能力，也希望在您这里编写的文档可以帮助到更多的同学。这是如何测试的？
完全的按照了
veui的 README 里面进行了安装，由于电脑的npm无法安装部分的包，所以使用了yarn来进行安装，故而增加了.gitignore文件。变化类型
清单：