mixpanel-js
官方的 Mixpanel JavaScript 客戶端函式庫
mixpanel-js 是什麼?
mixpanel-js 是 Mixpanel 的官方 JavaScript 用戶端函式庫。
mixpanel-js 概覽
這是什麼
mixpanel-js 是 Mixpanel(產品分析平台)的官方 JavaScript 客戶端函式庫。它提供一組附加在全域 mixpanel 物件上的方法,讓網站可以將資料傳送至 Mixpanel 專案。此函式庫以 NPM 套件 mixpanel-browser 的形式提供,以與 Mixpanel 的伺服器端 Node.js 函式庫(NPM 上名為 mixpanel)區別。它也可以透過 importmap 作為瀏覽器 JavaScript 模組載入。預設的套件包含一個捆綁的 mixpanel-recorder SDK 用於工作階段重播;也提供替代的匯入方式以排除它來減少套件大小。此函式庫支援在初始化時透過 flags 和 visual_experiments 選項設定視覺實驗和標誌傳遞。開發依賴項透過 npm install 安裝,函式庫透過 npm run build-dist 建置,該指令也會寫入一份涵蓋生產依賴項樹的 CycloneDX 軟體物料清單 (SBOM)。單元測試透過 npm test 執行,瀏覽器測試的測試伺服器透過 npm run integration_test 啟動。文件是透過 typedoc 從 JSDoc 和 TypeScript 定義產生的,使用 npm run build-docs 指令。
主要功能
- 將方法附加在全域
mixpanel物件上,用於將資料傳送至 Mixpanel 專案。 - 以 NPM 套件 (
mixpanel-browser) 形式提供,可與 Vite 或 Webpack 等前端打包工具搭配使用。 - 支援透過 importmap 作為瀏覽器 JavaScript 模組載入。
- 預設套件包含一個捆綁的
mixpanel-recorderSDK 用於工作階段重播;替代匯入方式可排除它以減少套件大小。 - 支援在初始化時透過
flags和visual_experiments選項設定視覺實驗和標誌傳遞。 - 建置程序會產生一份涵蓋生產依賴項樹的 CycloneDX 軟體物料清單 (SBOM)。
- 文件是透過 typedoc 從 JSDoc 和 TypeScript 定義產生的。
使用情境
mixpanel-js 適用於希望將資料傳送至 Mixpanel 專案的網站。它可用於追蹤使用者事件、管理使用者身分,以及啟用工作階段重播和視覺實驗。開發人員可以使用 NPM 和前端打包工具將其整合到網頁應用程式中,或直接將其作為瀏覽器模組載入。此函式庫適用於需要用戶端資料收集的產品分析使用情境。
快速開始
shnpm install --save mixpanel-browser``````javascriptimport mixpanel from 'mixpanel-browser';mixpanel.init('YOUR_TOKEN', {autocapture: true});mixpanel.track('An event');
授權與價格
授權條款為 Apache-2.0。價格類型標示為開放原始碼。
內容整理自該專案公開的 README 與儲存庫資訊。