fix: 调整文档

uiwjs · Apr 19, 2023 · 886e569 · 886e569
1 parent fb1ec1e
commit 886e569
Show file tree

Hide file tree

Showing 4 changed files with 31 additions and 39 deletions.
diff --git a/examples/website/src/pages/auth/README.md b/examples/website/src/pages/auth/README.md
@@ -12,16 +12,16 @@
 ```
 
 ## 二、路由和菜单
-当项目需要根据权限判断组件是否展示 使用组件时，请在 .kktprc.ts文件中配置全局变量(define)中AUTH=true
+当项目需要根据权限判断组件是否展示 使用组件时，在 `.kktprc.ts`文件中配置全局变量
+
 ```diff
-import config from "@uiw-admin/config"
-export default config({
+export default {
   define:{
-+    AUTH:true,
++   AUTH:true,
     //  ...
   }
   //  ...
-})
+}
 ```
 如果是路由权限判断,请在route.json中添加对应菜单的权限``isAuth``
 ```json

diff --git a/packages/authorized/README.md b/packages/authorized/README.md
@@ -7,17 +7,16 @@
 ## 何时使用
 
 当项目需要根据权限判断组件是否展示
-使用组件时，请在 `.kktprc.js`文件中配置全局变量(`define`)中`AUTH=true`
+使用组件时，请在 `.kktprc.js`文件中配置全局变量
 
 ```diff
-import config from "@uiw-admin/config"
-export default config({
+export default {
   define:{
-+    AUTH:true,
++   AUTH:true,
     //  ...
   }
   //  ...
-})
+}
 
 ```
 

diff --git a/packages/basic-layouts/README.md b/packages/basic-layouts/README.md
@@ -17,9 +17,9 @@ npm i @uiw-admin/basic-layouts --save # yarn add @uiw-admin/basic-layouts
 > 在项目中，`BasicLayouts`组件下如果不使用`LayoutTabs`组件内容放`react-router-dom` 的`Outlet`组件。否则只需要放`LayoutTabs`组件即可。
 
 ```jsx
+import { Outlet } from '@kkt/pro';
 import BasicLayout from '@uiw-admin/basic-layouts';
-import { Outlet } from 'react-router-dom';
-import LayoutTabs from "@uiw-admin/layout-tabs"
+import LayoutTabs from "@uiw-admin/layout-tabs";
 
 // 不使用 LayoutTabs 组件
 const Layouts = () => {
@@ -43,7 +43,7 @@ const Layouts = () => {
 ## 基本使用
 
 ```jsx mdx:preview
-import React from 'react'
+import React from 'react';
 import BasicLayout, { useLayouts } from '@uiw-admin/basic-layouts'
 import LayoutTabs from "@uiw-admin/layout-tabs";
 
@@ -79,13 +79,13 @@ function BasicLayoutScreen() {
     </div>
   )
 }
-export default BasicLayoutScreen
+export default BasicLayoutScreen;
 ```
 
 ## 头部布局
 
 ```jsx mdx:preview
-import React from 'react'
+import React from 'react';
 import BasicLayout, { useLayouts } from '@uiw-admin/basic-layouts'
 import LayoutTabs from "@uiw-admin/layout-tabs";
 
@@ -127,21 +127,20 @@ function BasicLayoutScreen() {
     </div>
   )
 }
-export default BasicLayoutScreen
+export default BasicLayoutScreen;
 ```
 
 **菜单搜索功能**
 
 在根目录`.kktprc.js`文件配置 `SEARCH_MENU` 参数，类型：`boolen` 默认`true`
 
 ```ts
-// .kktprc.js 
-import config from "@uiw-admin/config"
-export default config({
+// .kktprc.ts 
+export default {
   define:{
     SEARCH_MENU:true
   }
-})
+}
 ```
 
 ## 右侧头像部分配置
@@ -154,12 +153,9 @@ export default config({
 <!--rehype:bgwhite=true&codesandbox=true&codepen=true-->
 ```jsx mdx:preview
 window.SEARCH_MENU = true
-import React from 'react'
-import BasicLayout, {
-  useLayouts,
-} from '@uiw-admin/basic-layouts'
-import { HashRouter ,useRoutes ,Outlet} from 'react-router-dom';
-import LayoutTabs from "@uiw-admin/layout-tabs"
+import React from 'react';
+import BasicLayout, { useLayouts } from '@uiw-admin/basic-layouts';
+import LayoutTabs from "@uiw-admin/layout-tabs";
 
 const routerArrs = [
   {
@@ -221,7 +217,7 @@ function BasicLayoutScreen() {
   )
 }
 
-export default BasicLayoutScreen
+export default BasicLayoutScreen;
 ```
 
 
@@ -230,11 +226,10 @@ export default BasicLayoutScreen
 通过隐藏系统默认的退出登录，自定义退出登录
 
 ```jsx mdx:preview
-import React from 'react'
-import BasicLayout, {
-  useLayouts,
-} from '@uiw-admin/basic-layouts'
-import LayoutTabs from "@uiw-admin/layout-tabs"
+import React from 'react';
+import BasicLayout, { useLayouts } from '@uiw-admin/basic-layouts';
+import LayoutTabs from "@uiw-admin/layout-tabs";
+
 const routerArrs = [
   {
     path: "/components/authorized",
@@ -257,11 +252,9 @@ const routerArrs = [
 ]
 
 function BasicLayoutScreen() {
-
-  const layouts = useLayouts()
+  const layouts = useLayouts();
 
-
- const basicLayoutProps = {
+  const basicLayoutProps = {
     // 右侧下拉菜单内容
     menus: [
       {
@@ -305,7 +298,7 @@ function BasicLayoutScreen() {
     </div>
   )
 }
-export default BasicLayoutScreen
+export default BasicLayoutScreen;
 
 ```
 

diff --git a/packages/components/src/ProForm/README.md b/packages/components/src/ProForm/README.md
@@ -1292,8 +1292,8 @@ export default Demo
 
 ## 注意
 > [继承于uiw/Form,请参考uiw/From以及表单组件](https://uiwjs.github.io/#/components/form),
- 默认集成了`Input`,`Checkbox`,`Switch`,`Textarea`,`DateInput`,`TimePicker`,
- `MonthPicker`,`SearchSelect`,`Select`,`Radio`,`selectMultiple`,`Rate`,`Upload`。
+ 默认集成了`Input`, `InputNumber`, `Checkbox`, `Switch`, `Textarea`,`DateInput`, `TimePicker`,
+ `MonthPicker`, `SearchSelect`, `Select`, `Radio`, `selectMultiple`, `Rate`, `Upload`。
 <!--rehype:style=border-left: 8px solid #ffe564;background-color: #ffe56440;padding: 12px 16px;-->
 
 ## 贡献者