user-behavior-monitor 1.0.0

package/README.md

@@ -0,0 +1,106 @@
+# User Behavior Monitor Component
+
+Vue 2.5.2 兼容的用户行为监控组件，用于监测用户操作并在超时后自动登出。
+
+## 安装
+
+\`\`\`bash
+npm install git+https://code.mysugoncloud.com/linmingchuang/usermonitor.git
+# 安装特定分支
+npm install git+https://code.mysugoncloud.com/linmingchuang/usermonitor.git#branch-name
+
+# 安装特定标签
+npm install git+https://code.mysugoncloud.com/linmingchuang/usermonitor.git#v1.0.0
+\`\`\`
+"user-behavior-monitor": "file:/var/jenkins_home/workspace/web-usermonitor"
+## 使用方法
+
+### 方式一：全局注册
+
+\`\`\`javascript
+import Vue from 'vue';
+import UserBehaviorMonitor from 'user-behavior-monitor';
+import 'element-ui/lib/theme-chalk/index.css';
+
+Vue.use(UserBehaviorMonitor);
+\`\`\`
+
+### 方式二：局部注册
+
+\`\`\`javascript
+import UserBehaviorMonitor from 'user-behavior-monitor';
+
+export default {
+  components: {
+    UserBehaviorMonitor
+  }
+}
+\`\`\`
+
+### 在模板中使用
+
+\`\`\`vue
+<template>
+  <div id="app">
+    <!-- 其他组件 -->
+    <user-behavior-monitor
+      websocket-url="ws://localhost:8080/websocket"
+      :timeout-minutes="10"
+      :warning-minutes="1"
+      @logout="handleLogout"
+      @user-active="handleUserActive"
+      @timeout-warning="handleTimeoutWarning"
+    />
+  </div>
+</template>
+
+<script>
+import UserBehaviorMonitor from 'user-behavior-monitor';
+
+export default {
+  components: {
+    UserBehaviorMonitor
+  },
+  methods: {
+    handleLogout() {
+      // 处理登出逻辑，例如跳转到登录页
+      this.$router.push('/login');
+    },
+    handleUserActive() {
+      console.log('用户有活动');
+    },
+    handleTimeoutWarning() {
+      console.log('即将超时警告');
+    }
+  }
+};
+</script>
+\`\`\`
+
+## Props
+
+| 属性名 | 类型 | 默认值 | 说明 |
+| --- | --- | --- | --- |
+| websocket-url | String | 必填 | WebSocket服务器地址 |
+| timeout-minutes | Number | 10 | 超时时间（分钟） |
+| warning-minutes | Number | 1 | 警告提前时间（分钟） |
+
+## Events
+
+| 事件名 | 说明 |
+| --- | --- |
+| websocket-open | WebSocket连接建立 |
+| websocket-message | 收到WebSocket消息 |
+| websocket-error | WebSocket连接错误 |
+| websocket-close | WebSocket连接关闭 |
+| user-active | 用户有活动 |
+| timeout-warning | 超时警告 |
+| timeout | 超时 |
+| logout | 登出 |
+
+## 方法
+
+| 方法名 | 说明 |
+| --- | --- |
+| reset() | 手动重置监控计时器 |
+| reconnect() | 重新连接WebSocket |

package/dist/demo.html

@@ -0,0 +1,8 @@
+<meta charset="utf-8">
+<title>user-behavior-monitor demo</title>
+<script src="./user-behavior-monitor.umd.js"></script>
+
+
+<script>
+console.log(user-behavior-monitor)
+</script>