# cedar-track

> > 基于Vue3、神策的埋点工具

Latest version **1.0.15** (published 2024-03-14) · 0 weekly downloads

## Install

```sh
npm install cedar-track
pnpm add cedar-track
yarn add cedar-track
bun add cedar-track
```

## Health

**Score 20/100 (F)** — status: abandoned.

Positive: esm support; no vulnerabilities.

Warnings: low downloads; no types.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.15 |
| Published | 2024-03-14 |
| First published | 2024-02-28 |
| Weekly downloads | 0 |
| TypeScript types | none |
| Module format | ESM + CommonJS |
| Dependencies | 1 |
| Unpacked size | 1.2 MB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Maintainers | lushuaii |

## Links

- npm: https://www.npmjs.com/package/cedar-track
- npm.io page: https://npm.io/package/cedar-track

## Dependencies (1)

- [sa-sdk-javascript](https://npm.io/package/sa-sdk-javascript.md) ^1.26.6

## Recent versions

- 1.0.15 (latest) — 2024-03-14
- 1.0.8 — 2024-03-11
- 1.0.6 — 2024-03-04
- 1.0.5 — 2024-02-28

## README

# 埋点工具

> 基于Vue3、神策的埋点工具

```ts
npm install cedar-track

yarn add cedar-track
```

```ts
// main.ts
import { useSensors, useTrack } from 'cedar-track';
// app.config.globalProperties.$sensors = sensors
useSensors(app, {
  server_url: 'https://xxx/inquiry/acceptsdkinfo', // 后台接口地址
  show_log: true,
})
// 加载指令 v-saclick="{clickName:'XXX',clickData:{params1:'XXX',params2:'XX'}}"
useTrack(app)
```

```ts

interface SensorsOptions {
  /**
   * 埋点url
   */
  server_url: string;
  /**
   * 是否启用全埋点，默认值true
   */
  allTrack?: boolean;
  /**
   * 是否显示日志
   */
  show_log?: boolean;
  /**
   * 是否启用pageload 默认值false
   */
  pageload?: boolean;
  /**
  * 是否启用pageload 默认值false
  */
  pageleave?: boolean;
  /**
  * 应用名称
  */
  appName?: string;
  /**
  * 是否收集$WebClick，会被options.heatmap.clickmap覆盖
  */
  webClick: "not_collect" | "default";
  /**
  * 是否收集$WebStay，会被options.heatmap.scroll_notice_map覆盖
  */
  webStay: "not_collect" | "default";
}

// 默认值
allTrack: true,
show_log: false,
pageload: false,
pageleave: false,
server_url: "",
appName: "",
webClick: "default",
webStay: "default",
```

---
_Source: https://npm.io/package/cedar-track · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
