@wangofnextdoor/zlblog
Version:
浙里办日志和老年模式工具包
147 lines (102 loc) • 2.57 kB
Markdown
# @wx/zlblog
浙里办日志和老年模式工具包
## 安装
```bash
npm install @wx/zlblog
```
## 使用方法
### 初始化浙里办日志
```typescript
import { initZwlog, zwlogRecord } from '@wx/zlblog';
// 初始化日志
initZwlog('user123', '张三');
// 记录点击事件埋点
zwlogRecord('user123', '张三');
```
### 老年模式
```typescript
import { elderStyle, toggleElderStyle, isElderMode } from '@wx/zlblog';
// 初始化老年模式
elderStyle();
// 切换老年模式
toggleElderStyle('elder'); // 或 'normal'
// 检查是否为老年模式
const isElder = isElderMode();
```
### 配置管理
```typescript
import { ConfigManager } from '@wx/zlblog';
// 创建配置管理器
const configManager = new ConfigManager({
miniAppId: 'custom_app_id',
miniAppName: '自定义应用名称'
});
// 获取配置
const config = configManager.getConfig();
// 更新配置
configManager.updateConfig({
serviceCode: 'new_service_code'
});
```
### 工具函数
```typescript
import {
getCurRoute,
getNavigationBarTitleText,
getQueryVariable
} from '@wx/zlblog';
// 获取当前路由
const route = getCurRoute();
// 获取页面标题
const title = getNavigationBarTitleText();
// 获取URL参数
const param = getQueryVariable('key');
```
## API 文档
### 日志相关
#### initZwlog(userId: string, userNickName: string)
初始化浙里办日志
#### zwlogRecord(userId: string, userNick: string)
记录点击事件埋点
#### isLoad(bIsAlipayMini?: boolean)
登录跳转
#### getCurRoute(): string
获取当前页面路由
#### getNavigationBarTitleText(): string
获取页面标题
### 老年模式相关
#### elderStyle()
初始化老年模式
#### toggleElderStyle(uiStyle: UiStyle)
切换老年模式
#### isElderMode(): boolean
检查是否为老年模式
#### getCurrentUiStyle(): UiStyle
获取当前UI样式
#### setCssVar(prop: string, val: string, dom?: HTMLElement)
设置CSS变量
### 配置相关
#### ConfigManager
配置管理类
### 工具函数
#### getQueryVariable(name: string): string | null
获取URL查询参数
## 类型定义
```typescript
interface AppConfig {
miniAppId: string;
miniAppName: string;
appKey: string;
serviceCode: string;
servicePwd: string;
appCode: string;
accessKey: string;
secret: string;
}
type UiStyle = 'elder' | 'normal';
```
## 注意事项
1. 此包需要在浙里办环境中使用
2. 老年模式功能需要ZWJSBridge支持
3. 部分功能只能在浏览器环境中使用
4. 需要确保相关的外部依赖已正确加载