From 928e2364d924b5fe33869f07af7468126bc1c75c Mon Sep 17 00:00:00 2001 From: SimpleFrontend <627607+SimpleFrontend@users.noreply.github.com> Date: Mon, 5 Mar 2018 03:40:46 +0100 Subject: [PATCH] Translated the document of the Login component. (#953) * Translated the md files of Login component and the validation messages. * Rename index.md to index.en-US.md * Restored the Chinese version and renamed it * Updated according to review * Fixed all the typos --- src/components/Login/demo/basic.md | 22 +++++---- src/components/Login/index.en-US.md | 47 +++++++++++++++++++ .../Login/{index.md => index.zh-CN.md} | 7 +-- src/components/Login/map.js | 14 +++--- 4 files changed, 68 insertions(+), 22 deletions(-) create mode 100644 src/components/Login/index.en-US.md rename src/components/Login/{index.md => index.zh-CN.md} (96%) diff --git a/src/components/Login/demo/basic.md b/src/components/Login/demo/basic.md index 1fca454f..5fbd0ca2 100644 --- a/src/components/Login/demo/basic.md +++ b/src/components/Login/demo/basic.md @@ -1,9 +1,11 @@ --- order: 0 -title: Standard Login +title: + zh-CN: 标准登录 + en-US: Standard Login --- -支持账号密码及手机号登录两种模式。 +Support login with account and mobile number. ````jsx import Login from 'ant-design-pro/lib/Login'; @@ -26,7 +28,7 @@ class LoginDemo extends React.Component { if (!err && (values.username !== 'admin' || values.password !== '888888')) { setTimeout(() => { this.setState({ - notice: '账号或密码错误！', + notice: 'The combination of username and password is incorrect!', }); }, 500); } @@ -50,7 +52,7 @@ class LoginDemo extends React.Component { onTabChange={this.onTabChange} onSubmit={this.onSubmit} > - + { this.state.notice && @@ -58,21 +60,21 @@ class LoginDemo extends React.Component { - + console.log('Get captcha!')} name="captcha" />
- 自动登录 - 忘记密码 + Keep me logged in + Forgot password
- 登录 + Login
- 其他登录方式 + Other login methods - 注册账户 + Register
); diff --git a/src/components/Login/index.en-US.md b/src/components/Login/index.en-US.md new file mode 100644 index 00000000..bc38579f --- /dev/null +++ b/src/components/Login/index.en-US.md @@ -0,0 +1,47 @@ +--- +title: Login +cols: 1 +order: 15 +--- + +Support multiple common ways of login with built-in controls. You can choose your own combinations and use with your custom controls. + +## API + +### Login + +Property | Description | Type | Default +----|------|-----|------ +defaultActiveKey | default key to activate the tab panel | String | - +onTabChange | callback on changing tabs | (key) => void | - +onSubmit | callback on submit | (err, values) => void | - + +### Login.Tab + +Property | Description | Type | Default +----|------|-----|------ +key | key of the tab | String | - +tab | displayed text of the tab | ReactNode | - + +### Login.UserName + +Property | Description | Type | Default +----|------|-----|------ +name | name of the control, also the key of the submitted data | String | - +rules | validation rules, same with [option.rules](getFieldDecorator(id, options)) in Form getFieldDecorator(id, options) | object[] | - + +Apart from the above properties, Login.Username also support all properties of antd.Input, together with the default values of basic settings, such as _placeholder_, _size_ and _prefix_. All of these default values can be over-written. + +### Login.Password, Login.Mobile are the same as Login.UserName + +### Login.Captcha + +Property | Description | Type | Default +----|------|-----|------ +onGetCaptcha | callback on getting a new Captcha | () => void | - + +Apart from the above properties, _Login.Captcha_ support the same properties with _Login.UserName_. + +### Login.Submit + +Support all properties of _antd.Button_. \ No newline at end of file diff --git a/src/components/Login/index.md b/src/components/Login/index.zh-CN.md similarity index 96% rename from src/components/Login/index.md rename to src/components/Login/index.zh-CN.md index a56be08e..98f0f624 100644 --- a/src/components/Login/index.md +++ b/src/components/Login/index.zh-CN.md @@ -1,7 +1,5 @@ --- -title: - en-US: Login - zh-CN: Login +title: Login subtitle: 登录 cols: 1 order: 15 @@ -37,7 +35,7 @@ rules | 校验规则，同 Form getFieldDecorator(id, options) 中 [option.rules ### Login.Password、Login.Mobile 同 Login.UserName -### Login.Captcha +### Login.Captcha 参数 | 说明 | 类型 | 默认值 ----|------|-----|------ @@ -48,4 +46,3 @@ onGetCaptcha | 点击获取校验码的回调 | () => void | - ### Login.Submit 支持 antd.Button 的所有属性。 - diff --git a/src/components/Login/map.js b/src/components/Login/map.js index 81fd7a20..4f596fff 100644 --- a/src/components/Login/map.js +++ b/src/components/Login/map.js @@ -11,7 +11,7 @@ const map = { placeholder: 'admin', }, rules: [{ - required: true, message: '请输入账户名！', + required: true, message: 'Please enter username!', }], }, Password: { @@ -23,7 +23,7 @@ const map = { placeholder: '888888', }, rules: [{ - required: true, message: '请输入密码！', + required: true, message: 'Please enter password!', }], }, Mobile: { @@ -31,12 +31,12 @@ const map = { props: { size: 'large', prefix: , - placeholder: '手机号', + placeholder: 'mobile number', }, rules: [{ - required: true, message: '请输入手机号！', + required: true, message: 'Please enter mobile number!', }, { - pattern: /^1\d{10}$/, message: '手机号格式错误！', + pattern: /^1\d{10}$/, message: 'Wrong mobile number format!', }], }, Captcha: { @@ -44,10 +44,10 @@ const map = { props: { size: 'large', prefix: , - placeholder: '验证码', + placeholder: 'captcha', }, rules: [{ - required: true, message: '请输入验证码！', + required: true, message: 'Please enter Captcha!', }], }, }; -- GitLab