aptabase-react-native

KO | EN

gitlite — search

#javascript #hacktoberfest #react #ai #llm #go #docker #java #awesome #kubernetes #pytorch #ios #openai #open-source

aptabase-react-native

(★ 42)

React Native SDK for Aptabase: Open Source, Privacy-First and Simple Analytics for Mobile, Desktop and Web Apps

aptabase-react-native Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

![Aptabase](https://aptabase.com/og.png)

# React Native SDK for Aptabase

Instrument your React Native or Expo apps with Aptabase, an Open Source, Privacy-First and Simple Analytics for Mobile, Desktop and Web Apps.

## Install

Install the SDK using `npm` or your preferred JavaScript package manager

```bash
npm add @aptabase/react-native
```

## Android Requirements

If you're targeting Android, you'll need to add the following permissions to your `AndroidManifest.xml`:

```xml
<uses-permission android:name="android.permission.INTERNET" />
```

## Web Support

This SDK also supports React Native Web!

> [!NOTE]
> This feature is disabled by default. To enable it, you need to pass the `enableWeb` option when initializing the SDK.

```js
Aptabase.init("<YOUR_APP_KEY>", {
  enableWeb: true,
  appVersion: "1.0.0", // required on web — no native module provides it
});
```

When enabled, the SDK will track events in web environments using the same behavior as the web SDKs. Which means that events will be sent immediately to the `/event` endpoint instead of grouped to the `/events` endpoint.

## Usage

First, you need to get your `App Key` from Aptabase, you can find it in the `Instructions` menu on the left side menu.

Initialize the SDK by calling the `init` function before declaring your `App` component:

```js
import Aptabase from "@aptabase/react-native";

Aptabase.init("<YOUR_APP_KEY>"); // 👈 this is where you enter your App Key

export default function App() {
  return <Counter />;
}
```

Afterwards, you can start tracking events with `trackEvent`:

```js
import { trackEvent } from "@aptabase/react-native";
import { useState } from "react";

export function Counter() {
  const [count, setCount] = useState(0);

const increment = () => {
    setCount(count + 1);
    trackEvent("increment", { count });
  };

const decrement = () => {
    setCount(count - 1);
    trackEvent("decrement", { count });
  };

return (
    <View>
      <Button onPress={increment} title="Increment" />
      <Button onPress={decrement} title="Decrement" />
      <Text>Count is {count}</Text>
    </View>
  );
}
```

To disable tracking events, you can call the `dispose` function. This will stop and deinitialize the SDK.

```js
import Aptabase from "@aptabase/react-native";

Aptabase.dispose();
```

**Note for Expo apps:** Events sent during development while running on Expo Go will not have the `App Version` property because native modules are not available in Expo Go. However, when you build your app and run it on a real device, the `App Version` property will be available. Alternatively, you can also set the `appVersion` during the `init` call so that it's also available during development.

A few important notes:

1. The SDK will automatically enhance the event with some useful information, like the OS, the app version, and other things.
2. You're in control of what gets sent to Aptabase. This SDK does not automatically track any events, you need to call `trackEvent` manually.
   - Because of this, it's generally recommended to at least track an event at startup
3. You do not need to await for the `trackEvent` function, it'll run in the background.
4. Only strings and numbers values are allowed on custom properties

## Preparing for Submission to Apple App Store

When submitting your app to the Apple App Store, you'll need to fill out the `App Privacy` form. You can find all the answers on our [How to fill out the Apple App Privacy when using Aptabase](https://aptabase.com/docs/apple-app-privacy) guide.

For AI/LLM integration instructions, see [llms.txt](./llms.txt)

aptabase-react-native

aptabase-react-native Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

aptabase-react-native

aptabase-react-native Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README