@blocklet/ui-react 3.4.14 → 3.5.0

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.
Files changed (256) hide show
  1. package/lib/common/org-switch/use-org.d.ts +4 -4
  2. package/lib/common/ws.d.ts +22 -1
  3. package/package.json +10 -7
  4. package/.aigne/doc-smith/.local/afs-storage.sqlite3 +0 -0
  5. package/.aigne/doc-smith/config.yaml +0 -78
  6. package/.aigne/doc-smith/history.yaml +0 -14
  7. package/.aigne/doc-smith/media-description.yaml +0 -11
  8. package/.aigne/doc-smith/output/structure-plan.json +0 -255
  9. package/.aigne/doc-smith/translation-cache.yaml +0 -11
  10. package/.aigne/doc-smith/upload-cache.yaml +0 -528
  11. package/build.config.ts +0 -24
  12. package/docs/_sidebar.md +0 -19
  13. package/docs/assets/diagram/component-installer-diagram-0.ja.jpg +0 -0
  14. package/docs/assets/diagram/component-installer-diagram-0.jpg +0 -0
  15. package/docs/assets/diagram/component-installer-diagram-0.zh-TW.jpg +0 -0
  16. package/docs/assets/diagram/component-installer-diagram-0.zh.jpg +0 -0
  17. package/docs/assets/diagram/component-management-diagram-0.ja.jpg +0 -0
  18. package/docs/assets/diagram/component-management-diagram-0.jpg +0 -0
  19. package/docs/assets/diagram/component-management-diagram-0.zh-TW.jpg +0 -0
  20. package/docs/assets/diagram/component-management-diagram-0.zh.jpg +0 -0
  21. package/docs/assets/diagram/core-concepts-diagram-0.ja.jpg +0 -0
  22. package/docs/assets/diagram/core-concepts-diagram-0.jpg +0 -0
  23. package/docs/assets/diagram/core-concepts-diagram-0.zh-TW.jpg +0 -0
  24. package/docs/assets/diagram/core-concepts-diagram-0.zh.jpg +0 -0
  25. package/docs/assets/diagram/dashboard-diagram-0.ja.jpg +0 -0
  26. package/docs/assets/diagram/dashboard-diagram-0.jpg +0 -0
  27. package/docs/assets/diagram/dashboard-diagram-0.zh-TW.jpg +0 -0
  28. package/docs/assets/diagram/dashboard-diagram-0.zh.jpg +0 -0
  29. package/docs/assets/diagram/header-diagram-0.ja.jpg +0 -0
  30. package/docs/assets/diagram/header-diagram-0.jpg +0 -0
  31. package/docs/assets/diagram/header-diagram-0.zh-TW.jpg +0 -0
  32. package/docs/assets/diagram/header-diagram-0.zh.jpg +0 -0
  33. package/docs/assets/diagram/layout-diagram-0.ja.jpg +0 -0
  34. package/docs/assets/diagram/layout-diagram-0.jpg +0 -0
  35. package/docs/assets/diagram/layout-diagram-0.zh-TW.jpg +0 -0
  36. package/docs/assets/diagram/layout-diagram-0.zh.jpg +0 -0
  37. package/docs/assets/diagram/notifications-diagram-0.ja.jpg +0 -0
  38. package/docs/assets/diagram/notifications-diagram-0.jpg +0 -0
  39. package/docs/assets/diagram/notifications-diagram-0.zh-TW.jpg +0 -0
  40. package/docs/assets/diagram/notifications-diagram-0.zh.jpg +0 -0
  41. package/docs/assets/diagram/overview-diagram-0.ja.jpg +0 -0
  42. package/docs/assets/diagram/overview-diagram-0.jpg +0 -0
  43. package/docs/assets/diagram/overview-diagram-0.zh-TW.jpg +0 -0
  44. package/docs/assets/diagram/overview-diagram-0.zh.jpg +0 -0
  45. package/docs/assets/diagram/user-center-diagram-0.ja.jpg +0 -0
  46. package/docs/assets/diagram/user-center-diagram-0.jpg +0 -0
  47. package/docs/assets/diagram/user-center-diagram-0.zh-TW.jpg +0 -0
  48. package/docs/assets/diagram/user-center-diagram-0.zh.jpg +0 -0
  49. package/docs/assets/diagram/user-management-diagram-0.ja.jpg +0 -0
  50. package/docs/assets/diagram/user-management-diagram-0.jpg +0 -0
  51. package/docs/assets/diagram/user-management-diagram-0.zh-TW.jpg +0 -0
  52. package/docs/assets/diagram/user-management-diagram-0.zh.jpg +0 -0
  53. package/docs/assets/diagram/user-sessions-diagram-0.ja.jpg +0 -0
  54. package/docs/assets/diagram/user-sessions-diagram-0.jpg +0 -0
  55. package/docs/assets/diagram/user-sessions-diagram-0.zh-TW.jpg +0 -0
  56. package/docs/assets/diagram/user-sessions-diagram-0.zh.jpg +0 -0
  57. package/docs/components-component-management-blocklet-studio.ja.md +0 -194
  58. package/docs/components-component-management-blocklet-studio.md +0 -194
  59. package/docs/components-component-management-blocklet-studio.zh-TW.md +0 -194
  60. package/docs/components-component-management-blocklet-studio.zh.md +0 -194
  61. package/docs/components-component-management-component-installer.ja.md +0 -182
  62. package/docs/components-component-management-component-installer.md +0 -182
  63. package/docs/components-component-management-component-installer.zh-TW.md +0 -182
  64. package/docs/components-component-management-component-installer.zh.md +0 -182
  65. package/docs/components-component-management.ja.md +0 -30
  66. package/docs/components-component-management.md +0 -30
  67. package/docs/components-component-management.zh-TW.md +0 -30
  68. package/docs/components-component-management.zh.md +0 -30
  69. package/docs/components-layout-dashboard.ja.md +0 -185
  70. package/docs/components-layout-dashboard.md +0 -187
  71. package/docs/components-layout-dashboard.zh-TW.md +0 -185
  72. package/docs/components-layout-dashboard.zh.md +0 -185
  73. package/docs/components-layout-footer.ja.md +0 -165
  74. package/docs/components-layout-footer.md +0 -165
  75. package/docs/components-layout-footer.zh-TW.md +0 -165
  76. package/docs/components-layout-footer.zh.md +0 -165
  77. package/docs/components-layout-header.ja.md +0 -183
  78. package/docs/components-layout-header.md +0 -183
  79. package/docs/components-layout-header.zh-TW.md +0 -183
  80. package/docs/components-layout-header.zh.md +0 -183
  81. package/docs/components-layout.ja.md +0 -31
  82. package/docs/components-layout.md +0 -31
  83. package/docs/components-layout.zh-TW.md +0 -31
  84. package/docs/components-layout.zh.md +0 -31
  85. package/docs/components-notifications.ja.md +0 -125
  86. package/docs/components-notifications.md +0 -125
  87. package/docs/components-notifications.zh-TW.md +0 -125
  88. package/docs/components-notifications.zh.md +0 -125
  89. package/docs/components-user-management-user-center.ja.md +0 -148
  90. package/docs/components-user-management-user-center.md +0 -147
  91. package/docs/components-user-management-user-center.zh-TW.md +0 -148
  92. package/docs/components-user-management-user-center.zh.md +0 -148
  93. package/docs/components-user-management-user-sessions.ja.md +0 -121
  94. package/docs/components-user-management-user-sessions.md +0 -123
  95. package/docs/components-user-management-user-sessions.zh-TW.md +0 -121
  96. package/docs/components-user-management-user-sessions.zh.md +0 -121
  97. package/docs/components-user-management.ja.md +0 -49
  98. package/docs/components-user-management.md +0 -51
  99. package/docs/components-user-management.zh-TW.md +0 -49
  100. package/docs/components-user-management.zh.md +0 -49
  101. package/docs/components-utilities-icon.ja.md +0 -106
  102. package/docs/components-utilities-icon.md +0 -106
  103. package/docs/components-utilities-icon.zh-TW.md +0 -106
  104. package/docs/components-utilities-icon.zh.md +0 -106
  105. package/docs/components-utilities.ja.md +0 -136
  106. package/docs/components-utilities.md +0 -136
  107. package/docs/components-utilities.zh-TW.md +0 -136
  108. package/docs/components-utilities.zh.md +0 -136
  109. package/docs/components.ja.md +0 -27
  110. package/docs/components.md +0 -27
  111. package/docs/components.zh-TW.md +0 -27
  112. package/docs/components.zh.md +0 -27
  113. package/docs/core-concepts.ja.md +0 -134
  114. package/docs/core-concepts.md +0 -135
  115. package/docs/core-concepts.zh-TW.md +0 -134
  116. package/docs/core-concepts.zh.md +0 -134
  117. package/docs/getting-started.ja.md +0 -132
  118. package/docs/getting-started.md +0 -132
  119. package/docs/getting-started.zh-TW.md +0 -132
  120. package/docs/getting-started.zh.md +0 -132
  121. package/docs/hooks-api.ja.md +0 -214
  122. package/docs/hooks-api.md +0 -214
  123. package/docs/hooks-api.zh-TW.md +0 -214
  124. package/docs/hooks-api.zh.md +0 -214
  125. package/docs/how-to-guides.ja.md +0 -413
  126. package/docs/how-to-guides.md +0 -413
  127. package/docs/how-to-guides.zh-TW.md +0 -413
  128. package/docs/how-to-guides.zh.md +0 -413
  129. package/docs/overview.ja.md +0 -51
  130. package/docs/overview.md +0 -51
  131. package/docs/overview.zh-TW.md +0 -51
  132. package/docs/overview.zh.md +0 -51
  133. package/glossary.md +0 -12
  134. package/src/@types/index.ts +0 -230
  135. package/src/@types/shims.d.ts +0 -18
  136. package/src/BlockletStudio/README.md +0 -116
  137. package/src/BlockletStudio/index.tsx +0 -145
  138. package/src/ComponentInstaller/ComponentInstaller.stories.jsx +0 -16
  139. package/src/ComponentInstaller/index.jsx +0 -207
  140. package/src/ComponentInstaller/installer-item.jsx +0 -129
  141. package/src/ComponentInstaller/locales.js +0 -22
  142. package/src/ComponentInstaller/use-component-installed.js +0 -88
  143. package/src/ComponentManager/components/add-component.tsx +0 -136
  144. package/src/ComponentManager/components/check-component.tsx +0 -3
  145. package/src/ComponentManager/components/publish-component.tsx +0 -90
  146. package/src/ComponentManager/components/resource-dialog.tsx +0 -91
  147. package/src/ComponentManager/index.tsx +0 -3
  148. package/src/ComponentManager/libs/locales.ts +0 -15
  149. package/src/Dashboard/Dashboard.stories.jsx +0 -20
  150. package/src/Dashboard/app-shell/app-badge.stories.tsx +0 -64
  151. package/src/Dashboard/app-shell/app-badge.tsx +0 -94
  152. package/src/Dashboard/app-shell/app-header.tsx +0 -104
  153. package/src/Dashboard/app-shell/app-info-context.tsx +0 -182
  154. package/src/Dashboard/app-shell/badges/app-badge-default.tsx +0 -130
  155. package/src/Dashboard/app-shell/badges/app-badge-did.tsx +0 -28
  156. package/src/Dashboard/app-shell/badges/app-badge-state.tsx +0 -40
  157. package/src/Dashboard/app-shell/badges/app-badge-switch.tsx +0 -72
  158. package/src/Dashboard/app-shell/badges/app-badge-version.tsx +0 -60
  159. package/src/Dashboard/app-shell/index.ts +0 -5
  160. package/src/Dashboard/index.jsx +0 -184
  161. package/src/Footer/Footer.stories.jsx +0 -33
  162. package/src/Footer/brand.jsx +0 -81
  163. package/src/Footer/copyright.jsx +0 -22
  164. package/src/Footer/index.jsx +0 -111
  165. package/src/Footer/internal-footer.jsx +0 -139
  166. package/src/Footer/layout/plain.jsx +0 -55
  167. package/src/Footer/layout/row.jsx +0 -43
  168. package/src/Footer/layout/standard.jsx +0 -114
  169. package/src/Footer/links.jsx +0 -321
  170. package/src/Footer/social-media.jsx +0 -55
  171. package/src/Header/Header.stories.jsx +0 -30
  172. package/src/Header/index.tsx +0 -259
  173. package/src/Icon/Icon.stories.jsx +0 -12
  174. package/src/Icon/index.tsx +0 -87
  175. package/src/Notifications/Snackbar.tsx +0 -261
  176. package/src/Notifications/hooks/use-title.tsx +0 -254
  177. package/src/Notifications/hooks/use-width.tsx +0 -16
  178. package/src/Notifications/utils.ts +0 -246
  179. package/src/UserCenter/assets/banner.png +0 -0
  180. package/src/UserCenter/components/config-inviter.tsx +0 -48
  181. package/src/UserCenter/components/config-profile.tsx +0 -99
  182. package/src/UserCenter/components/danger-zone.tsx +0 -82
  183. package/src/UserCenter/components/editable-field.tsx +0 -273
  184. package/src/UserCenter/components/fallback.tsx +0 -57
  185. package/src/UserCenter/components/nft-preview.tsx +0 -84
  186. package/src/UserCenter/components/nft.tsx +0 -279
  187. package/src/UserCenter/components/notification.tsx +0 -319
  188. package/src/UserCenter/components/passport.tsx +0 -107
  189. package/src/UserCenter/components/privacy.tsx +0 -120
  190. package/src/UserCenter/components/settings.tsx +0 -170
  191. package/src/UserCenter/components/status-dialog/date-picker.tsx +0 -77
  192. package/src/UserCenter/components/status-dialog/index.tsx +0 -293
  193. package/src/UserCenter/components/status-selector/duration-menu.tsx +0 -90
  194. package/src/UserCenter/components/status-selector/index.tsx +0 -58
  195. package/src/UserCenter/components/status-selector/menu-item.tsx +0 -56
  196. package/src/UserCenter/components/storage/action.tsx +0 -49
  197. package/src/UserCenter/components/storage/connected.tsx +0 -61
  198. package/src/UserCenter/components/storage/delete.tsx +0 -72
  199. package/src/UserCenter/components/storage/disconnect.tsx +0 -40
  200. package/src/UserCenter/components/storage/icons/empty-spaces-nft.svg +0 -1
  201. package/src/UserCenter/components/storage/icons/long-arrow.svg +0 -5
  202. package/src/UserCenter/components/storage/icons/space-connected.svg +0 -3
  203. package/src/UserCenter/components/storage/icons/space-disconnect.svg +0 -3
  204. package/src/UserCenter/components/storage/index.tsx +0 -41
  205. package/src/UserCenter/components/storage/preview-nft.tsx +0 -72
  206. package/src/UserCenter/components/third-party-login/index.tsx +0 -199
  207. package/src/UserCenter/components/third-party-login/third-party-item.tsx +0 -296
  208. package/src/UserCenter/components/user-center.tsx +0 -787
  209. package/src/UserCenter/components/user-info/address.tsx +0 -143
  210. package/src/UserCenter/components/user-info/index.tsx +0 -4
  211. package/src/UserCenter/components/user-info/link-preview-input.tsx +0 -274
  212. package/src/UserCenter/components/user-info/metadata.tsx +0 -658
  213. package/src/UserCenter/components/user-info/social-actions/chat.tsx +0 -43
  214. package/src/UserCenter/components/user-info/social-actions/follow.tsx +0 -23
  215. package/src/UserCenter/components/user-info/social-actions/index.tsx +0 -17
  216. package/src/UserCenter/components/user-info/switch-role.tsx +0 -42
  217. package/src/UserCenter/components/user-info/timezone-select.tsx +0 -119
  218. package/src/UserCenter/components/user-info/user-basic-info.tsx +0 -292
  219. package/src/UserCenter/components/user-info/user-info-item.tsx +0 -54
  220. package/src/UserCenter/components/user-info/user-info.tsx +0 -91
  221. package/src/UserCenter/components/user-info/user-status.tsx +0 -234
  222. package/src/UserCenter/components/user-info/utils.ts +0 -320
  223. package/src/UserCenter/components/webhook-item.tsx +0 -248
  224. package/src/UserCenter/index.tsx +0 -1
  225. package/src/UserCenter/libs/locales.ts +0 -378
  226. package/src/UserCenter/libs/utils.ts +0 -30
  227. package/src/UserSessions/components/user-session-info.tsx +0 -78
  228. package/src/UserSessions/components/user-sessions.tsx +0 -545
  229. package/src/UserSessions/index.tsx +0 -1
  230. package/src/UserSessions/libs/locales.ts +0 -60
  231. package/src/UserSessions/libs/utils.ts +0 -82
  232. package/src/blocklets.js +0 -195
  233. package/src/common/domain-warning.jsx +0 -178
  234. package/src/common/header-addons.jsx +0 -119
  235. package/src/common/link-blocker.jsx +0 -20
  236. package/src/common/notification-addon.jsx +0 -135
  237. package/src/common/org-switch/avatar-uploader.jsx +0 -271
  238. package/src/common/org-switch/create.jsx +0 -267
  239. package/src/common/org-switch/index.jsx +0 -407
  240. package/src/common/org-switch/locales.js +0 -52
  241. package/src/common/org-switch/use-org.jsx +0 -79
  242. package/src/common/overridable-theme-provider.jsx +0 -17
  243. package/src/common/wallet-hidden-topbar.js +0 -14
  244. package/src/common/wizard-modal.jsx +0 -200
  245. package/src/common/ws.js +0 -68
  246. package/src/contexts/config-user-space.tsx +0 -88
  247. package/src/contexts/user-followers.tsx +0 -54
  248. package/src/hooks/use-follow.tsx +0 -75
  249. package/src/hooks/use-mobile.tsx +0 -6
  250. package/src/index.ts +0 -16
  251. package/src/libs/constant.ts +0 -1
  252. package/src/libs/spaces.tsx +0 -18
  253. package/src/libs/with-hide-when-embed.tsx +0 -24
  254. package/src/types.js +0 -45
  255. package/src/utils.js +0 -161
  256. package/vite.config.mjs +0 -34
@@ -1,6 +1,6 @@
1
1
  export default function useOrg(session: any): {
2
- getOrgs: (this: any, args_0?: any) => Promise<any>;
3
- createOrg: (this: any, args_0?: any) => Promise<any>;
4
- updateOrg: (this: any, orgId?: any, args_1?: any) => Promise<any>;
5
- getCurrentOrg: (this: any, roleName?: any) => Promise<any>;
2
+ getOrgs: (this: any, args_0: any) => Promise<any>;
3
+ createOrg: (this: any, args_0: any) => Promise<any>;
4
+ updateOrg: (this: any, orgId: any, args_1: any) => Promise<any>;
5
+ getCurrentOrg: (this: any, roleName: any) => Promise<any>;
6
6
  };
@@ -1,3 +1,24 @@
1
- export function create(endpoint?: string): any;
1
+ export function create(endpoint?: string): {
2
+ _logger: ReturnType<(subModule: string, silent?: boolean) => import('@arcblock/ws/esm/logger.mjs').Logger>;
3
+ emitter: import('@arcblock/ws/esm/client/base.mjs').EventEmitterInstance;
4
+ on(event: string, handler: (data: unknown) => void, params?: object): void;
5
+ off(event: string, handler?: (data: unknown) => void): void;
6
+ disconnect(callback?: () => void, code?: number, reason?: string): void;
7
+ ensureJoinChannel(topic: string, params?: object): void;
8
+ ensureLeaveChannel(topic: string): void;
9
+ subscribe(topic: string, params?: object): import('@arcblock/ws/esm/client/base.mjs').Channel;
10
+ unsubscribe(topic: string): void;
11
+ channels: import('@arcblock/ws/esm/client/base.mjs').Channel[];
12
+ connect(): void;
13
+ isConnected(): boolean;
14
+ onOpen(cb: () => void): void;
15
+ onClose(cb: () => void): void;
16
+ onError(cb: (err: {
17
+ error: Error;
18
+ }) => void): void;
19
+ onMessage(cb: (message: unknown) => void): void;
20
+ channel(topic: string, params?: object | (() => object)): import('@arcblock/ws/esm/client/base.mjs').Channel;
21
+ remove(channel: import('@arcblock/ws/esm/client/base.mjs').Channel): void;
22
+ };
2
23
  export default function getWsClient(endpoint?: string): any;
3
24
  export function useListenWsClient(endpoint?: string): any;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@blocklet/ui-react",
3
- "version": "3.4.14",
3
+ "version": "3.5.0",
4
4
  "description": "Some useful front-end web components that can be used in Blocklets.",
5
5
  "keywords": [
6
6
  "react",
@@ -36,10 +36,10 @@
36
36
  "dependencies": {
37
37
  "@abtnode/constant": "^1.17.7",
38
38
  "@abtnode/util": "^1.17.7",
39
- "@arcblock/bridge": "3.4.14",
40
- "@arcblock/icons": "3.4.14",
41
- "@arcblock/react-hooks": "3.4.14",
42
- "@arcblock/ws": "^1.28.8",
39
+ "@arcblock/bridge": "3.5.0",
40
+ "@arcblock/icons": "3.5.0",
41
+ "@arcblock/react-hooks": "3.5.0",
42
+ "@arcblock/ws": "^1.29.4",
43
43
  "@blocklet/did-space-react": "^1.2.15",
44
44
  "@blocklet/uploader": "^0.3.19",
45
45
  "@iconify-icons/logos": "^1.2.36",
@@ -80,11 +80,14 @@
80
80
  "react": "^19.0.0",
81
81
  "react-router-dom": "^6.22.3"
82
82
  },
83
+ "files": [
84
+ "lib"
85
+ ],
83
86
  "publishConfig": {
84
87
  "access": "public"
85
88
  },
86
89
  "devDependencies": {
87
- "@arcblock/did-connect-react": "3.4.14",
90
+ "@arcblock/did-connect-react": "3.5.0",
88
91
  "@babel/preset-env": "^7.28.0",
89
92
  "@babel/preset-react": "^7.27.1",
90
93
  "@babel/preset-typescript": "^7.27.1",
@@ -98,5 +101,5 @@
98
101
  "typescript": "~5.5.4",
99
102
  "unbuild": "^2.0.0"
100
103
  },
101
- "gitHead": "d663390d3c6a9b2d8d71790c770dd0025ae309de"
104
+ "gitHead": "1cfc816004525cf1b352ec2b64d459f4769f0237"
102
105
  }
@@ -1,78 +0,0 @@
1
- # Project information for documentation publishing
2
- projectName: Blocklet UI (React)
3
- projectDesc: '@blocklet/ui-react offers components for Blocklet dev to speed up development.'
4
- projectLogo: 'https://www.arcblock.io/.well-known/service/blocklet/logo'
5
-
6
- # =============================================================================
7
- # Documentation Configuration
8
- # =============================================================================
9
-
10
- # Purpose: What's the main outcome you want readers to achieve?
11
- # Available options (uncomment and modify as needed):
12
- # getStarted - Get started quickly: Help new users go from zero to working in <30 minutes
13
- # completeTasks - Complete specific tasks: Guide users through common workflows and use cases
14
- # findAnswers - Find answers fast: Provide searchable reference for all features and APIs
15
- # understandSystem - Understand the system: Explain how it works, why design decisions were made
16
- # solveProblems - Troubleshoot common issues: Help users troubleshoot and fix issues
17
- # mixedPurpose - Serve multiple purposes: Comprehensive documentation covering multiple needs
18
- documentPurpose:
19
- - getStarted
20
- - completeTasks
21
-
22
- # Target Audience: Who will be reading this most often?
23
- # Available options (uncomment and modify as needed):
24
- # endUsers - End users (non-technical): People who use the product but don't code
25
- # developers - Developers integrating your product/API: Engineers adding this to their projects
26
- # devops - DevOps / SRE / Infrastructure teams: Teams deploying, monitoring, maintaining systems
27
- # decisionMakers - Technical decision makers: Architects, leads evaluating or planning implementation
28
- # supportTeams - Support teams: People helping others use the product
29
- # mixedTechnical - Mixed technical audience: Developers, DevOps, and technical users
30
- targetAudienceTypes:
31
- - developers
32
-
33
- # Reader Knowledge Level: What do readers typically know when they arrive?
34
- # Available options (uncomment and modify as needed):
35
- # completeBeginners - Is a total beginner, starting from scratch: New to this domain/technology entirely
36
- # domainFamiliar - Has used similar tools before: Know the problem space, new to this specific solution
37
- # experiencedUsers - Is an expert trying to do something specific: Regular users needing reference/advanced topics
38
- # emergencyTroubleshooting - Emergency/troubleshooting: Something's broken, need to fix it quickly
39
- # exploringEvaluating - Is evaluating this tool against others: Trying to understand if this fits their needs
40
- readerKnowledgeLevel: completeBeginners
41
-
42
- # Documentation Depth: How comprehensive should the documentation be?
43
- # Available options (uncomment and modify as needed):
44
- # essentialOnly - Essential only: Cover the 80% use cases, keep it concise
45
- # balancedCoverage - Balanced coverage: Good depth with practical examples [RECOMMENDED]
46
- # comprehensive - Comprehensive: Cover all features, edge cases, and advanced scenarios
47
- # aiDecide - Let AI decide: Analyze code complexity and suggest appropriate depth
48
- documentationDepth: balancedCoverage
49
-
50
- # Custom Rules: Define specific documentation generation rules and requirements
51
- rules: ''
52
-
53
- # Target Audience: Describe your specific target audience and their characteristics
54
- targetAudience: ''
55
-
56
- # Glossary: Define project-specific terms and definitions
57
- glossary: '@glossary.md' # Path to markdown file containing glossary definitions
58
-
59
- locale: en
60
- # translateLanguages: # List of languages to translate the documentation to
61
- # - zh # Example: Chinese translation
62
- # - en # Example: English translation
63
- docsDir: docs # Directory to save generated documentation
64
- sourcesPath: # Source code paths to analyze
65
- - src
66
- - ./tests
67
- - ./README.md
68
- lastGitHead: 49a6dabae8a06667e517c6811f5f7939ff907ce1
69
- appUrl: https://docsmith.aigne.io
70
- boardId: blocklet-ui-react
71
- # Checkout ID for document deployment service
72
- checkoutId: ""
73
- translateLanguages:
74
- - zh
75
- - zh-TW
76
- - ja
77
- # Should sync branding for documentation
78
- shouldSyncBranding: ""
@@ -1,14 +0,0 @@
1
- entries:
2
- - timestamp: 2025-12-05T01:32:41.364Z
3
- operation: document_update
4
- feedback: 使用手绘风格的图表
5
- docPaths:
6
- - /overview
7
- - timestamp: 2025-10-10T07:34:02.876Z
8
- operation: document_update
9
- feedback: d2 图表的效果不好,请重新生成
10
- documentPath: /components/user-management/user-center
11
- - timestamp: 2025-10-10T07:30:02.608Z
12
- operation: document_update
13
- feedback: d2 图表的效果不好,请重新生成
14
- documentPath: /components/notifications
@@ -1,11 +0,0 @@
1
- descriptions:
2
- b64f0212be4c7f38dcd4cf260d4af6d23d7f9a011a091361e80b96ddda29e433:
3
- path: ../src/UserCenter/assets/banner.png
4
- description: This wide, abstract banner image features a dynamic arrangement of
5
- numerous 3D cubes, rendered in soft pastel shades of blue, purple, pink,
6
- and white, with subtle orange accents. The geometric forms are positioned
7
- at varying heights and angles, creating a layered composition with gentle
8
- light and shadow effects. This clean, modern graphic is ideal for use as a
9
- header, banner, or decorative background in documentation.
10
- generatedAt: 2025-12-05T01:26:47.959Z
11
- lastUpdated: 2025-12-05T01:26:47.963Z
@@ -1,255 +0,0 @@
1
- [
2
- {
3
- "title": "Overview",
4
- "description": "Provides a high-level introduction to the Blocklet UI React library, outlining the problems it solves, its core components, and the overall architecture.",
5
- "path": "/overview",
6
- "sourceIds": [
7
- "src/index.ts",
8
- "README.md",
9
- "src/Header/index.tsx",
10
- "src/Footer/index.jsx",
11
- "src/Dashboard/index.jsx",
12
- "src/UserCenter/index.tsx",
13
- "src/ComponentInstaller/index.jsx",
14
- "src/blocklets.js",
15
- "src/utils.js"
16
- ],
17
- "parentId": "",
18
- "icon": "lucide:book-open"
19
- },
20
- {
21
- "title": "Getting Started",
22
- "description": "A concise guide to quickly install the library and render your first components, such as a Header and Footer, in under 30 minutes.",
23
- "path": "/getting-started",
24
- "sourceIds": [
25
- "README.md",
26
- "src/index.ts",
27
- "src/Header/index.tsx",
28
- "src/Footer/index.jsx",
29
- "src/common/overridable-theme-provider.jsx"
30
- ],
31
- "parentId": "",
32
- "icon": "lucide:rocket"
33
- },
34
- {
35
- "title": "Core Concepts",
36
- "description": "Explains the fundamental principles of the library, focusing on how it uses the blocklet's metadata to automatically configure and render components.",
37
- "path": "/core-concepts",
38
- "sourceIds": [
39
- "src/blocklets.js",
40
- "src/types.js",
41
- "src/@types/index.ts",
42
- "src/utils.js"
43
- ],
44
- "parentId": "",
45
- "icon": "lucide:lightbulb"
46
- },
47
- {
48
- "title": "Components",
49
- "description": "A detailed reference for all available UI components, complete with props, usage examples, and best practices for integration.",
50
- "path": "/components",
51
- "sourceIds": [
52
- "src/index.ts",
53
- "src/Header/index.tsx",
54
- "src/Footer/index.jsx",
55
- "src/Dashboard/index.jsx",
56
- "src/Icon/index.tsx",
57
- "src/ComponentInstaller/index.jsx",
58
- "src/BlockletStudio/index.tsx",
59
- "src/UserCenter/index.tsx",
60
- "src/UserSessions/index.tsx",
61
- "src/ComponentManager/index.tsx",
62
- "src/common/notification-addon.jsx"
63
- ],
64
- "parentId": "",
65
- "icon": "lucide:blocks"
66
- },
67
- {
68
- "title": "Layout",
69
- "description": "Documentation for primary layout components like Header, Footer, and Dashboard that form the main structure of a blocklet application.",
70
- "path": "/components/layout",
71
- "sourceIds": [
72
- "src/Header/index.tsx",
73
- "src/Footer/index.jsx",
74
- "src/Dashboard/index.jsx"
75
- ],
76
- "parentId": "/components"
77
- },
78
- {
79
- "title": "Header",
80
- "description": "Provides a responsive and customizable header, automatically populated with navigation links and user session controls from the blocklet's metadata.",
81
- "path": "/components/layout/header",
82
- "sourceIds": [
83
- "src/Header/index.tsx",
84
- "src/common/header-addons.jsx",
85
- "src/common/domain-warning.jsx",
86
- "src/common/org-switch/index.jsx",
87
- "src/libs/with-hide-when-embed.tsx",
88
- "src/blocklets.js",
89
- "src/utils.js"
90
- ],
91
- "parentId": "/components/layout"
92
- },
93
- {
94
- "title": "Footer",
95
- "description": "Renders a consistent footer for your application, including branding, copyright information, social media links, and additional navigation.",
96
- "path": "/components/layout/footer",
97
- "sourceIds": [
98
- "src/Footer/index.jsx",
99
- "src/Footer/internal-footer.jsx",
100
- "src/Footer/brand.jsx",
101
- "src/Footer/links.jsx",
102
- "src/Footer/social-media.jsx",
103
- "src/Footer/copyright.jsx",
104
- "src/Footer/layout/standard.jsx",
105
- "src/Footer/layout/plain.jsx",
106
- "src/libs/with-hide-when-embed.tsx"
107
- ],
108
- "parentId": "/components/layout"
109
- },
110
- {
111
- "title": "Dashboard",
112
- "description": "A pre-built dashboard layout with a sidebar, header, and content area, designed for admin interfaces and user-centric views.",
113
- "path": "/components/layout/dashboard",
114
- "sourceIds": [
115
- "src/Dashboard/index.jsx",
116
- "src/common/header-addons.jsx",
117
- "src/blocklets.js"
118
- ],
119
- "parentId": "/components/layout"
120
- },
121
- {
122
- "title": "User Management",
123
- "description": "A suite of components for handling user profiles, session management, and organization switching.",
124
- "path": "/components/user-management",
125
- "sourceIds": [
126
- "src/UserCenter/index.tsx",
127
- "src/UserSessions/index.tsx",
128
- "src/common/org-switch/index.jsx",
129
- "src/hooks/use-follow.tsx",
130
- "src/contexts/user-followers.tsx"
131
- ],
132
- "parentId": "/components"
133
- },
134
- {
135
- "title": "UserCenter",
136
- "description": "A comprehensive user profile and settings component that includes passport management, privacy controls, and notification settings.",
137
- "path": "/components/user-management/user-center",
138
- "sourceIds": [
139
- "src/UserCenter/index.tsx",
140
- "src/UserCenter/components/user-center.tsx",
141
- "src/UserCenter/components/user-info/index.tsx",
142
- "src/UserCenter/components/user-info/user-basic-info.tsx",
143
- "src/UserCenter/components/passport.tsx",
144
- "src/UserCenter/components/settings.tsx",
145
- "src/UserCenter/components/privacy.tsx",
146
- "src/UserCenter/components/notification.tsx",
147
- "src/UserCenter/components/storage/index.tsx",
148
- "src/UserCenter/components/third-party-login/index.tsx",
149
- "src/contexts/config-user-space.tsx",
150
- "src/contexts/user-followers.tsx"
151
- ],
152
- "parentId": "/components/user-management"
153
- },
154
- {
155
- "title": "UserSessions",
156
- "description": "Displays and manages a user's active and expired login sessions across different devices and platforms.",
157
- "path": "/components/user-management/user-sessions",
158
- "sourceIds": [
159
- "src/UserSessions/index.tsx",
160
- "src/UserSessions/components/user-sessions.tsx",
161
- "src/UserSessions/libs/utils.ts"
162
- ],
163
- "parentId": "/components/user-management"
164
- },
165
- {
166
- "title": "Component Management",
167
- "description": "Tools for dynamically installing, publishing, and managing blocklet components within an application.",
168
- "path": "/components/component-management",
169
- "sourceIds": [
170
- "src/ComponentInstaller/index.jsx",
171
- "src/ComponentManager/index.tsx",
172
- "src/BlockletStudio/index.tsx"
173
- ],
174
- "parentId": "/components"
175
- },
176
- {
177
- "title": "ComponentInstaller",
178
- "description": "A component that checks for missing blocklet dependencies and provides an interface for administrators to install them.",
179
- "path": "/components/component-management/component-installer",
180
- "sourceIds": [
181
- "src/ComponentInstaller/index.jsx",
182
- "src/ComponentInstaller/use-component-installed.js",
183
- "src/ComponentInstaller/installer-item.jsx"
184
- ],
185
- "parentId": "/components/component-management"
186
- },
187
- {
188
- "title": "BlockletStudio",
189
- "description": "An embeddable interface for publishing and managing resources and components within the Blocklet ecosystem.",
190
- "path": "/components/component-management/blocklet-studio",
191
- "sourceIds": [
192
- "src/BlockletStudio/index.tsx",
193
- "src/BlockletStudio/README.md"
194
- ],
195
- "parentId": "/components/component-management"
196
- },
197
- {
198
- "title": "Notifications",
199
- "description": "Provides components and utilities for implementing a real-time user notification system.",
200
- "path": "/components/notifications",
201
- "sourceIds": [
202
- "src/common/notification-addon.jsx",
203
- "src/Notifications/Snackbar.tsx",
204
- "src/Notifications/utils.ts",
205
- "src/common/ws.js"
206
- ],
207
- "parentId": "/components"
208
- },
209
- {
210
- "title": "Utilities",
211
- "description": "A collection of helper components and utilities, such as a versatile Icon component and theme providers.",
212
- "path": "/components/utilities",
213
- "sourceIds": [
214
- "src/Icon/index.tsx",
215
- "src/common/overridable-theme-provider.jsx",
216
- "src/libs/with-hide-when-embed.tsx",
217
- "src/utils.js"
218
- ],
219
- "parentId": "/components"
220
- },
221
- {
222
- "title": "Icon",
223
- "description": "A flexible icon component that supports Iconify strings, image URLs, and letter avatars, built on top of Material-UI's Avatar.",
224
- "path": "/components/utilities/icon",
225
- "sourceIds": [
226
- "src/Icon/index.tsx"
227
- ],
228
- "parentId": "/components/utilities"
229
- },
230
- {
231
- "title": "Hooks API",
232
- "description": "Reference for the custom React Hooks provided by the library to encapsulate and reuse stateful logic.",
233
- "path": "/hooks-api",
234
- "sourceIds": [
235
- "src/ComponentInstaller/use-component-installed.js",
236
- "src/hooks/use-follow.tsx",
237
- "src/hooks/use-mobile.tsx"
238
- ],
239
- "parentId": "",
240
- "icon": "lucide:hook"
241
- },
242
- {
243
- "title": "How-to Guides",
244
- "description": "Practical, step-by-step guides for completing common tasks and implementing specific workflows using the library's components.",
245
- "path": "/how-to-guides",
246
- "sourceIds": [
247
- "src/Header/demo/addons-customization.jsx",
248
- "src/ComponentInstaller/index.jsx",
249
- "src/common/notification-addon.jsx",
250
- "src/BlockletStudio/README.md"
251
- ],
252
- "parentId": "",
253
- "icon": "lucide:compass"
254
- }
255
- ]
@@ -1,11 +0,0 @@
1
- Blocklet UI (React):
2
- en: Blocklet UI (React)
3
- zh: Blocklet UI (React)
4
- zh-TW: Blocklet UI (React)
5
- ja: Blocklet UI (React)
6
- "@blocklet/ui-react offers components for Blocklet dev to speed up development.":
7
- en: "@blocklet/ui-react offers components for Blocklet dev to speed up
8
- development."
9
- zh: "@blocklet/ui-react 为 Blocklet 开发者提供组件,以加快开发速度。"
10
- zh-TW: "@blocklet/ui-react 為 Blocklet 開發者提供元件,以加快開發速度。"
11
- ja: "@blocklet/ui-reactは、Blocklet開発を加速するためのコンポーネントを提供します。"