@flow97/react-toolkit 0.0.2 → 0.0.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/CHANGELOG.md CHANGED
@@ -1,5 +1,11 @@
1
1
  # react-toolkits
2
2
 
3
+ ## 0.0.3
4
+
5
+ ### Patch Changes
6
+
7
+ - df5b54f: refactor: rename ToolkitsProvider to ToolkitProvider and update related imports
8
+
3
9
  ## 0.0.2
4
10
 
5
11
  ### Patch Changes
package/README.md CHANGED
@@ -37,7 +37,7 @@ import { QueryClient, QueryClientProvider } from '@tanstack/react-query'
37
37
  import 'react-toolkits/style.css'
38
38
  import { createRoot } from 'react-dom/client'
39
39
  import { RouterProvider } from 'react-router'
40
- import { ToolkitsProvider } from 'react-toolkits/components'
40
+ import { ToolkitProvider } from 'react-toolkits/components'
41
41
  import { AuthMode } from 'react-toolkits/constants'
42
42
 
43
43
  import router from './router'
@@ -61,16 +61,16 @@ const root = createRoot(document.getElementById('root') as HTMLElement)
61
61
 
62
62
  root.render(
63
63
  <QueryClientProvider client={queryClient}>
64
- <ToolkitsProvider collapsible gameApiV2 auth={{ mode: AuthMode.GROUP_BASED }} loginPath="/sign_in" mainPagePath="/">
64
+ <ToolkitProvider collapsible gameApiV2 auth={{ mode: AuthMode.GROUP_BASED }} loginPath="/sign_in" mainPagePath="/">
65
65
  <RouterProvider router={router} />
66
- </ToolkitsProvider>
66
+ </ToolkitProvider>
67
67
  </QueryClientProvider>,
68
68
  )
69
69
  ```
70
70
 
71
- **重要提示**:`QueryClientProvider` 必须包裹 `ToolkitsProvider`,因为 `react-toolkits` 内部使用了 `@tanstack/react-query` 的 hooks(如 `useQueryClient`、`useQuery`、`useMutation`)。
71
+ **重要提示**:`QueryClientProvider` 必须包裹 `ToolkitProvider`,因为 `react-toolkits` 内部使用了 `@tanstack/react-query` 的 hooks(如 `useQueryClient`、`useQuery`、`useMutation`)。
72
72
 
73
- ### 配置项(`ToolkitsProvider`)
73
+ ### 配置项(`ToolkitProvider`)
74
74
 
75
75
  - **loginPath**: 登录页路径(未鉴权时会跳转)
76
76
  - **mainPagePath**: 登录后主页路径(鉴权通过时进入)
@@ -81,7 +81,7 @@ root.render(
81
81
 
82
82
  ## 子路径导出(推荐)
83
83
 
84
- - `react-toolkits/components`:组件与 Hooks(如 `Layout`、`ToolkitsProvider`、`InfiniteList`)
84
+ - `react-toolkits/components`:组件与 Hooks(如 `Layout`、`ToolkitProvider`、`InfiniteList`)
85
85
  - `react-toolkits/hooks`:表单弹层 Hooks(如 `useFormDrawer`、`useFormModal`)
86
86
  - `react-toolkits/pages`:内置页面与路由片段(如 `permissionRoutes`、`menuRoutes`、`SignIn`)
87
87
  - `react-toolkits/services`:请求相关 Hooks(如 `useAuth`、`useMenuList`、`useGames`)
@@ -324,13 +324,13 @@ export default function FetchWithKy() {
324
324
  过去:
325
325
 
326
326
  ```ts
327
- import { ToolkitsProvider, Layout, useFormDrawer } from '@flow97/react-toolkit'
327
+ import { ToolkitProvider, Layout, useFormDrawer } from '@flow97/react-toolkit'
328
328
  ```
329
329
 
330
330
  现在(推荐):
331
331
 
332
332
  ```ts
333
- import { ToolkitsProvider, Layout } from 'react-toolkits/components'
333
+ import { ToolkitProvider, Layout } from 'react-toolkits/components'
334
334
  import { useFormDrawer, useFormModal } from 'react-toolkits/hooks'
335
335
  import { permissionRoutes } from 'react-toolkits/pages'
336
336
  import { useAuth } from 'react-toolkits/services'
@@ -341,14 +341,14 @@ import { useAuth } from 'react-toolkits/services'
341
341
  ### 权限版本兼容
342
342
 
343
343
  - 历史上存在不同权限数据结构,`AuthMode` 用于适配后端变体
344
- - 新项目建议使用 `V3`;旧项目如为 `V2`,只需在 `ToolkitsProvider` 中切换版本
344
+ - 新项目建议使用 `V3`;旧项目如为 `V2`,只需在 `ToolkitProvider` 中切换版本
345
345
 
346
346
  ## 常见问题(FAQ)
347
347
 
348
348
  - 如何引入样式?
349
349
  - 在应用入口一次性引入:`import 'react-toolkits/style.css'`
350
350
  - Provider 放哪?
351
- - 在应用根部使用 `ToolkitsProvider`,传入登录路径、主页路径、权限版本等配置。
351
+ - 在应用根部使用 `ToolkitProvider`,传入登录路径、主页路径、权限版本等配置。
352
352
  - 如何自定义菜单?
353
353
  - 通过 `Layout` 的 `items` 或参考示例应用的 `menu-items.tsx`。
354
354
  - 如何统一请求与拦截?