From 3f1615cf801898ba3084540b321daf2c3cf407f1 Mon Sep 17 00:00:00 2001 From: "troy.lty" Date: Sun, 12 Jan 2020 11:29:48 +0800 Subject: [PATCH] feat: support i18n --- .umirc.js | 3 ++ README_zh-CN.md => README.zh-CN.md | 0 package.json | 2 +- src/useBoolean/{index.md => index.en-US.md} | 0 src/useBoolean/index.zh-CN.md | 44 +++++++++++++++++++++ 5 files changed, 48 insertions(+), 1 deletion(-) rename README_zh-CN.md => README.zh-CN.md (100%) rename src/useBoolean/{index.md => index.en-US.md} (100%) create mode 100644 src/useBoolean/index.zh-CN.md diff --git a/.umirc.js b/.umirc.js index efbe958f78..f45b0bb641 100644 --- a/.umirc.js +++ b/.umirc.js @@ -7,4 +7,7 @@ export default { style: true, }, ]], + doc: { + locales: [['en-US', 'English'], ['zh-CN', '中文']] + } } diff --git a/README_zh-CN.md b/README.zh-CN.md similarity index 100% rename from README_zh-CN.md rename to README.zh-CN.md diff --git a/package.json b/package.json index ecb2ece822..82376c5160 100755 --- a/package.json +++ b/package.json @@ -58,7 +58,7 @@ "docz-theme-umi-hooks": "^0.0.7", "enzyme": "^3.10.0", "father": "^2.13.3", - "father-doc": "^1.0.0-alpha.4", + "father-doc": "^1.0.0-alpha.13", "jackbox": "^0.2.0", "now": "^16.2.0", "raw-loader": "^3.1.0", diff --git a/src/useBoolean/index.md b/src/useBoolean/index.en-US.md similarity index 100% rename from src/useBoolean/index.md rename to src/useBoolean/index.en-US.md diff --git a/src/useBoolean/index.zh-CN.md b/src/useBoolean/index.zh-CN.md new file mode 100644 index 0000000000..587fa678e4 --- /dev/null +++ b/src/useBoolean/index.zh-CN.md @@ -0,0 +1,44 @@ +--- +title: useBoolean +group: + title: State Hooks + path: /state +--- + +# useBoolean + +A hook that elegantly manages boolean values. + +## Examples + +### Default usage + + + +## API + +```javascript +const { + state, + toggle, + setTrue, + setFalse +} = useBoolean( + defaultValue?: boolean, +); +``` + +### Result + +| Property | Description | Type | +|----------|--------------------------------------|----------------------| +| state | State value | boolean | +| toggle | Trigger state change, accept an optional parameter | (value?: any) => void | +| setTrue | Set state value true | () => void | +| setFalse | Set state value false | () => void | + +### Params + +| Property | Description | Type | Default | +|---------|----------------------------------------------|------------------------|--------| +| defaultValue | Optional,set a default value | boolean \| undefined | false |