@blocklet/ui-react 3.1.48 → 3.1.50

package/.aigne/doc-smith/config.yaml

@@ -0,0 +1,76 @@
+# Project information for documentation publishing
+projectName: Blocklet UI (React)
+projectDesc: '@blocklet/ui-react offers components for Blocklet dev to speed up development.'
+projectLogo: 'https://www.arcblock.io/.well-known/service/blocklet/logo'
+
+# =============================================================================
+# Documentation Configuration
+# =============================================================================
+
+# Purpose: What's the main outcome you want readers to achieve?
+# Available options (uncomment and modify as needed):
+#   getStarted       - Get started quickly: Help new users go from zero to working in <30 minutes
+#   completeTasks    - Complete specific tasks: Guide users through common workflows and use cases
+#   findAnswers      - Find answers fast: Provide searchable reference for all features and APIs
+#   understandSystem - Understand the system: Explain how it works, why design decisions were made
+#   solveProblems    - Troubleshoot common issues: Help users troubleshoot and fix issues
+#   mixedPurpose     - Serve multiple purposes: Comprehensive documentation covering multiple needs
+documentPurpose:
+  - getStarted
+  - completeTasks
+
+# Target Audience: Who will be reading this most often?
+# Available options (uncomment and modify as needed):
+#   endUsers         - End users (non-technical): People who use the product but don't code
+#   developers       - Developers integrating your product/API: Engineers adding this to their projects
+#   devops           - DevOps / SRE / Infrastructure teams: Teams deploying, monitoring, maintaining systems
+#   decisionMakers   - Technical decision makers: Architects, leads evaluating or planning implementation
+#   supportTeams     - Support teams: People helping others use the product
+#   mixedTechnical   - Mixed technical audience: Developers, DevOps, and technical users
+targetAudienceTypes:
+  - developers
+
+# Reader Knowledge Level: What do readers typically know when they arrive?
+# Available options (uncomment and modify as needed):
+#   completeBeginners    - Is a total beginner, starting from scratch: New to this domain/technology entirely
+#   domainFamiliar       - Has used similar tools before: Know the problem space, new to this specific solution
+#   experiencedUsers     - Is an expert trying to do something specific: Regular users needing reference/advanced topics
+#   emergencyTroubleshooting - Emergency/troubleshooting: Something's broken, need to fix it quickly
+#   exploringEvaluating  - Is evaluating this tool against others: Trying to understand if this fits their needs
+readerKnowledgeLevel: completeBeginners
+
+# Documentation Depth: How comprehensive should the documentation be?
+# Available options (uncomment and modify as needed):
+#   essentialOnly      - Essential only: Cover the 80% use cases, keep it concise
+#   balancedCoverage   - Balanced coverage: Good depth with practical examples [RECOMMENDED]
+#   comprehensive      - Comprehensive: Cover all features, edge cases, and advanced scenarios
+#   aiDecide           - Let AI decide: Analyze code complexity and suggest appropriate depth
+documentationDepth: balancedCoverage
+
+# Custom Rules: Define specific documentation generation rules and requirements
+rules: ''
+
+# Target Audience: Describe your specific target audience and their characteristics
+targetAudience: ''
+
+# Glossary: Define project-specific terms and definitions
+glossary: '@glossary.md' # Path to markdown file containing glossary definitions
+
+locale: en
+# translateLanguages:  # List of languages to translate the documentation to
+#   - zh  # Example: Chinese translation
+#   - en  # Example: English translation
+docsDir: docs # Directory to save generated documentation
+sourcesPath: # Source code paths to analyze
+  - src
+  - ./tests
+  - ./README.md
+lastGitHead: 49a6dabae8a06667e517c6811f5f7939ff907ce1
+appUrl: https://docsmith.aigne.io
+boardId: blocklet-ui-react
+# Checkout ID for document deployment service
+checkoutId: ""
+translateLanguages:
+  - zh
+  - zh-TW
+  - ja

package/.aigne/doc-smith/history.yaml

@@ -0,0 +1,9 @@
+entries:
+  - timestamp: 2025-10-10T07:34:02.876Z
+    operation: document_update
+    feedback: d2 图表的效果不好，请重新生成
+    documentPath: /components/user-management/user-center
+  - timestamp: 2025-10-10T07:30:02.608Z
+    operation: document_update
+    feedback: d2 图表的效果不好，请重新生成
+    documentPath: /components/notifications

package/.aigne/doc-smith/output/structure-plan.json

@@ -0,0 +1,249 @@
+[
+  {
+    "title": "Overview",
+    "description": "Provides a high-level introduction to the Blocklet UI React library, outlining the problems it solves, its core components, and the overall architecture.",
+    "path": "/overview",
+    "sourceIds": [
+      "src/index.ts",
+      "README.md",
+      "src/Header/index.tsx",
+      "src/Footer/index.jsx",
+      "src/Dashboard/index.jsx",
+      "src/UserCenter/index.tsx",
+      "src/ComponentInstaller/index.jsx",
+      "src/blocklets.js",
+      "src/utils.js"
+    ],
+    "parentId": ""
+  },
+  {
+    "title": "Getting Started",
+    "description": "A concise guide to quickly install the library and render your first components, such as a Header and Footer, in under 30 minutes.",
+    "path": "/getting-started",
+    "sourceIds": [
+      "README.md",
+      "src/index.ts",
+      "src/Header/index.tsx",
+      "src/Footer/index.jsx",
+      "src/common/overridable-theme-provider.jsx"
+    ],
+    "parentId": ""
+  },
+  {
+    "title": "Core Concepts",
+    "description": "Explains the fundamental principles of the library, focusing on how it uses the blocklet's metadata to automatically configure and render components.",
+    "path": "/core-concepts",
+    "sourceIds": [
+      "src/blocklets.js",
+      "src/types.js",
+      "src/@types/index.ts",
+      "src/utils.js"
+    ],
+    "parentId": ""
+  },
+  {
+    "title": "Components",
+    "description": "A detailed reference for all available UI components, complete with props, usage examples, and best practices for integration.",
+    "path": "/components",
+    "sourceIds": [
+      "src/index.ts",
+      "src/Header/index.tsx",
+      "src/Footer/index.jsx",
+      "src/Dashboard/index.jsx",
+      "src/Icon/index.tsx",
+      "src/ComponentInstaller/index.jsx",
+      "src/BlockletStudio/index.tsx",
+      "src/UserCenter/index.tsx",
+      "src/UserSessions/index.tsx",
+      "src/ComponentManager/index.tsx",
+      "src/common/notification-addon.jsx"
+    ],
+    "parentId": ""
+  },
+  {
+    "title": "Layout",
+    "description": "Documentation for primary layout components like Header, Footer, and Dashboard that form the main structure of a blocklet application.",
+    "path": "/components/layout",
+    "sourceIds": [
+      "src/Header/index.tsx",
+      "src/Footer/index.jsx",
+      "src/Dashboard/index.jsx"
+    ],
+    "parentId": "/components"
+  },
+  {
+    "title": "Header",
+    "description": "Provides a responsive and customizable header, automatically populated with navigation links and user session controls from the blocklet's metadata.",
+    "path": "/components/layout/header",
+    "sourceIds": [
+      "src/Header/index.tsx",
+      "src/common/header-addons.jsx",
+      "src/common/domain-warning.jsx",
+      "src/common/org-switch/index.jsx",
+      "src/libs/with-hide-when-embed.tsx",
+      "src/blocklets.js",
+      "src/utils.js"
+    ],
+    "parentId": "/components/layout"
+  },
+  {
+    "title": "Footer",
+    "description": "Renders a consistent footer for your application, including branding, copyright information, social media links, and additional navigation.",
+    "path": "/components/layout/footer",
+    "sourceIds": [
+      "src/Footer/index.jsx",
+      "src/Footer/internal-footer.jsx",
+      "src/Footer/brand.jsx",
+      "src/Footer/links.jsx",
+      "src/Footer/social-media.jsx",
+      "src/Footer/copyright.jsx",
+      "src/Footer/layout/standard.jsx",
+      "src/Footer/layout/plain.jsx",
+      "src/libs/with-hide-when-embed.tsx"
+    ],
+    "parentId": "/components/layout"
+  },
+  {
+    "title": "Dashboard",
+    "description": "A pre-built dashboard layout with a sidebar, header, and content area, designed for admin interfaces and user-centric views.",
+    "path": "/components/layout/dashboard",
+    "sourceIds": [
+      "src/Dashboard/index.jsx",
+      "src/common/header-addons.jsx",
+      "src/blocklets.js"
+    ],
+    "parentId": "/components/layout"
+  },
+  {
+    "title": "User Management",
+    "description": "A suite of components for handling user profiles, session management, and organization switching.",
+    "path": "/components/user-management",
+    "sourceIds": [
+      "src/UserCenter/index.tsx",
+      "src/UserSessions/index.tsx",
+      "src/common/org-switch/index.jsx",
+      "src/hooks/use-follow.tsx",
+      "src/contexts/user-followers.tsx"
+    ],
+    "parentId": "/components"
+  },
+  {
+    "title": "UserCenter",
+    "description": "A comprehensive user profile and settings component that includes passport management, privacy controls, and notification settings.",
+    "path": "/components/user-management/user-center",
+    "sourceIds": [
+      "src/UserCenter/index.tsx",
+      "src/UserCenter/components/user-center.tsx",
+      "src/UserCenter/components/user-info/index.tsx",
+      "src/UserCenter/components/user-info/user-basic-info.tsx",
+      "src/UserCenter/components/passport.tsx",
+      "src/UserCenter/components/settings.tsx",
+      "src/UserCenter/components/privacy.tsx",
+      "src/UserCenter/components/notification.tsx",
+      "src/UserCenter/components/storage/index.tsx",
+      "src/UserCenter/components/third-party-login/index.tsx",
+      "src/contexts/config-user-space.tsx",
+      "src/contexts/user-followers.tsx"
+    ],
+    "parentId": "/components/user-management"
+  },
+  {
+    "title": "UserSessions",
+    "description": "Displays and manages a user's active and expired login sessions across different devices and platforms.",
+    "path": "/components/user-management/user-sessions",
+    "sourceIds": [
+      "src/UserSessions/index.tsx",
+      "src/UserSessions/components/user-sessions.tsx",
+      "src/UserSessions/libs/utils.ts"
+    ],
+    "parentId": "/components/user-management"
+  },
+  {
+    "title": "Component Management",
+    "description": "Tools for dynamically installing, publishing, and managing blocklet components within an application.",
+    "path": "/components/component-management",
+    "sourceIds": [
+      "src/ComponentInstaller/index.jsx",
+      "src/ComponentManager/index.tsx",
+      "src/BlockletStudio/index.tsx"
+    ],
+    "parentId": "/components"
+  },
+  {
+    "title": "ComponentInstaller",
+    "description": "A component that checks for missing blocklet dependencies and provides an interface for administrators to install them.",
+    "path": "/components/component-management/component-installer",
+    "sourceIds": [
+      "src/ComponentInstaller/index.jsx",
+      "src/ComponentInstaller/use-component-installed.js",
+      "src/ComponentInstaller/installer-item.jsx"
+    ],
+    "parentId": "/components/component-management"
+  },
+  {
+    "title": "BlockletStudio",
+    "description": "An embeddable interface for publishing and managing resources and components within the Blocklet ecosystem.",
+    "path": "/components/component-management/blocklet-studio",
+    "sourceIds": [
+      "src/BlockletStudio/index.tsx",
+      "src/BlockletStudio/README.md"
+    ],
+    "parentId": "/components/component-management"
+  },
+  {
+    "title": "Notifications",
+    "description": "Provides components and utilities for implementing a real-time user notification system.",
+    "path": "/components/notifications",
+    "sourceIds": [
+      "src/common/notification-addon.jsx",
+      "src/Notifications/Snackbar.tsx",
+      "src/Notifications/utils.ts",
+      "src/common/ws.js"
+    ],
+    "parentId": "/components"
+  },
+  {
+    "title": "Utilities",
+    "description": "A collection of helper components and utilities, such as a versatile Icon component and theme providers.",
+    "path": "/components/utilities",
+    "sourceIds": [
+      "src/Icon/index.tsx",
+      "src/common/overridable-theme-provider.jsx",
+      "src/libs/with-hide-when-embed.tsx",
+      "src/utils.js"
+    ],
+    "parentId": "/components"
+  },
+  {
+    "title": "Icon",
+    "description": "A flexible icon component that supports Iconify strings, image URLs, and letter avatars, built on top of Material-UI's Avatar.",
+    "path": "/components/utilities/icon",
+    "sourceIds": [
+      "src/Icon/index.tsx"
+    ],
+    "parentId": "/components/utilities"
+  },
+  {
+    "title": "Hooks API",
+    "description": "Reference for the custom React Hooks provided by the library to encapsulate and reuse stateful logic.",
+    "path": "/hooks-api",
+    "sourceIds": [
+      "src/ComponentInstaller/use-component-installed.js",
+      "src/hooks/use-follow.tsx",
+      "src/hooks/use-mobile.tsx"
+    ],
+    "parentId": ""
+  },
+  {
+    "title": "How-to Guides",
+    "description": "Practical, step-by-step guides for completing common tasks and implementing specific workflows using the library's components.",
+    "path": "/how-to-guides",
+    "sourceIds": [
+      "src/Header/demo/addons-customization.jsx",
+      "src/ComponentInstaller/index.jsx",
+      "src/common/notification-addon.jsx",
+      "src/BlockletStudio/README.md"
+    ],
+    "parentId": ""
+  }
+]