feat: support i18n

LiFBoy · Jan 12, 2020 · 3f1615c · 3f1615c
1 parent f166d69
commit 3f1615c
Show file tree

Hide file tree

Showing 5 changed files with 48 additions and 1 deletion.
diff --git 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 → README.zh-CN.md b/README_zh-CN.md → README.zh-CN.md
diff --git 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 → src/useBoolean/index.en-US.md b/src/useBoolean/index.md → src/useBoolean/index.en-US.md
diff --git a/src/useBoolean/index.zh-CN.md 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
+
+<code src="./demo/demo1.tsx" />
+
+## 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      |
-Original file line number
+Diff line change
@@ Expand Up / @@ -7,4 +7,7 @@ export default { @@
           style: true,
         },
       ]],
+      doc: {
+        locales: [['en-US', 'English'], ['zh-CN', '中文']]
+      }
     }