@qy_better_lib/hooks 0.2.5 → 0.2.7

package/DOCUMENTATION.md

@@ -256,6 +256,8 @@ close();
 
 ### 5. use-mqtt - MQTT功能
 
+> 注意：MQTT功能现在是可选依赖，需要单独导入
+
 #### 功能描述
 适用于需要MQTT通信的场景，支持连接管理、消息订阅和发布。
 
@@ -273,7 +275,7 @@ close();
 
 #### 示例
 ```typescript
-import { use_mqtt } from '@qy_better_lib/hooks';
+import { use_mqtt } from '@qy_better_lib/hooks/use-mqtt';
 
 const { connect, close, subscribe, publish } = use_mqtt('mqtt://localhost:1883', {
   clientId: 'test-client',
@@ -389,6 +391,8 @@ close(() => {
 
 ### 7. use-chart - 图表管理
 
+> 注意：图表管理功能现在是可选依赖，需要单独导入
+
 #### 功能描述
 适用于需要在前端使用ECharts的场景，支持图表渲染、主题切换、响应式设计等功能。
 
@@ -406,7 +410,7 @@ close(() => {
 - **返回类型**: `Promise<any>` - 图表实例
 - **示例**:
   ```typescript
-  import { use_chart } from '@qy_better_lib/hooks';
+  import { use_chart } from '@qy_better_lib/hooks/use-chart';
   
   const { render_chart } = use_chart();
   
@@ -437,7 +441,7 @@ close(() => {
 - **返回类型**: `boolean` - 是否更新成功
 - **示例**:
   ```typescript
-  import { use_chart } from '@qy_better_lib/hooks';
+  import { use_chart } from '@qy_better_lib/hooks/use-chart';
   
   const { update_chart } = use_chart();
   
@@ -457,7 +461,7 @@ close(() => {
 - **返回类型**: `boolean` - 是否删除成功
 - **示例**:
   ```typescript
-  import { use_chart } from '@qy_better_lib/hooks';
+  import { use_chart } from '@qy_better_lib/hooks/use-chart';
   
   const { remove_chart } = use_chart();
   
@@ -473,7 +477,7 @@ close(() => {
 - **返回类型**: `string | null` - 图片URL
 - **示例**:
   ```typescript
-  import { use_chart } from '@qy_better_lib/hooks';
+  import { use_chart } from '@qy_better_lib/hooks/use-chart';
   
   const { export_chart_image } = use_chart();
   
@@ -483,6 +487,8 @@ close(() => {
 
 ### 8. use-layout-flow - 流程图布局
 
+> 注意：流程图布局功能现在是可选依赖，需要单独导入
+
 #### 功能描述
 适用于需要自动布局的流程图场景，支持多种布局方向和自定义元素。
 
@@ -498,7 +504,7 @@ close(() => {
 - **返回类型**: `Promise<boolean>` - 是否初始化成功
 - **示例**:
   ```typescript
-  import { use_layout_flow } from '@qy_better_lib/hooks';
+  import { use_layout_flow } from '@qy_better_lib/hooks/use-layout-flow';
   
   const { init } = use_layout_flow({});
   
@@ -515,7 +521,7 @@ close(() => {
 - **返回类型**: `Promise<boolean>` - 是否布局成功
 - **示例**:
   ```typescript
-  import { use_layout_flow } from '@qy_better_lib/hooks';
+  import { use_layout_flow } from '@qy_better_lib/hooks/use-layout-flow';
   
   const { layout } = use_layout_flow({});
   
@@ -535,7 +541,7 @@ close(() => {
 - **返回类型**: `any[]` - 创建的节点数组
 - **示例**:
   ```typescript
-  import { use_layout_flow } from '@qy_better_lib/hooks';
+  import { use_layout_flow } from '@qy_better_lib/hooks/use-layout-flow';
   
   const { create_nodes } = use_layout_flow({});
   
@@ -567,7 +573,7 @@ close(() => {
 - **返回类型**: `any[]` - 创建的边数组
 - **示例**:
   ```typescript
-  import { use_layout_flow } from '@qy_better_lib/hooks';
+  import { use_layout_flow } from '@qy_better_lib/hooks/use-layout-flow';
   
   const { create_edges } = use_layout_flow({});
   
@@ -617,61 +623,12 @@ emitter.on('test', (data) => {
 emitter.off('test', listener);
 ```
 
-### 10. use-websocket - WebSocket功能
-
-#### 功能描述
-适用于需要在前端实现WebSocket通信的场景，支持自动重连、心跳检测、消息队列等功能。
-
-#### 参数
-- `options: WebSocketOptions` - WebSocket配置选项
-
-#### 返回值
-- **ws**: `WebSocket | undefined` - WebSocket实例
-- **create**: `() => void` - 创建连接
-- **close**: `() => void` - 关闭连接
-- **send_message**: `(msg: any) => boolean` - 发送消息
-- **get_status**: `() => WebSocketStatus` - 获取连接状态
-- **reconnect**: `() => void` - 重连
-- **start_heartbeat**: `() => void` - 启动心跳检测
-- **stop_heartbeat**: `() => void` - 停止心跳检测
-
-#### 示例
-```typescript
-import { use_web_socket } from '@qy_better_lib/hooks';
 
-const { create, close, send_message, get_status } = use_web_socket({
-  server: 'ws://localhost:8080',
-  receive: (event) => {
-    console.log('收到消息:', event.data);
-  },
-  on_open: () => {
-    console.log('连接成功');
-  },
-  on_error: (error) => {
-    console.error('连接错误:', error);
-  },
-  on_close: () => {
-    console.log('连接关闭');
-  },
-  auto_reconnect: true,
-  heartbeat_interval: 30000
-});
-
-// 发送消息
-send_message('Hello WebSocket');
-
-// 获取连接状态
-const status = get_status();
-console.log(status);
-
-// 关闭连接
-close();
-```
 
 ## 注意事项
 
-1. **use-chart** 需要安装 ECharts 依赖：`npm install echarts`
-2. **use-layout-flow** 需要安装 @antv/x6 和 dagre 依赖：`npm install @antv/x6 dagre`
-3. **use-mqtt** 需要安装 mqtt 依赖：`npm install mqtt`
+1. **use-chart** 现在是可选依赖，需要单独导入：`import { use_chart } from '@qy_better_lib/hooks/use-chart'`，并需要安装 ECharts 依赖：`npm install echarts`
+2. **use-layout-flow** 现在是可选依赖，需要单独导入：`import { use_layout_flow } from '@qy_better_lib/hooks/use-layout-flow'`，并需要安装 @antv/x6 和 dagre 依赖：`npm install @antv/x6 dagre`
+3. **use-mqtt** 现在是可选依赖，需要单独导入：`import { use_mqtt } from '@qy_better_lib/hooks/use-mqtt'`，并需要安装 mqtt 依赖：`npm install mqtt`
 4. **use-websocket** 需要确保服务器端支持 WebSocket 协议
 5. **use-print** 在某些浏览器中可能存在兼容性问题，建议在现代浏览器中使用