Skip to content
This repository has been archived by the owner on Nov 16, 2022. It is now read-only.

terveystalo/react-native-piwik-pro-sdk

Repository files navigation

⚠️ Deprecated: Terveystalo will deprecate and archive this repository within next month. There is another library for react native at https://developers.piwik.pro/en/latest/data_collection/mobile/Piwik_PRO_SDK_for_React_Native.html.


react-native-piwik-pro-sdk

React Native wrapper for the native Piwik PRO SDKs.

Installation

npm install react-native-piwik-pro-sdk

Usage

import * as PiwikProSdk from 'react-native-piwik-pro-sdk';

// Initialize tracker
await PiwikProSdk.init(
  'https://demoaccess.piwik.pro/',
  '3e7e6ab9-d605-42b0-ac1b-cdf5bb5e216f'
);

// Track screen
await PiwikProSdk.trackScreen(
  'main/list', // Path
  {
    1: 'first',
  } // Custom dimensions { [index: number]: value: string } (optional)
);

// Track event
await PiwikProSdk.trackEvent(
  'app', // Category
  'launch', // Action
  'notification', // Name (optional)
  1.04, // Value (optional)
  {
    1: 'first',
    2: 'second',
  } // Custom dimensions { [index: number]: value: string } (optional)
);

For more details, see the code in src/index.tsx.

Contributing

See the contributing guide to learn how to contribute to the repository and the development workflow.

License

MIT