@capgo/capacitor-contentsquare

Capacitor 8 wrapper for the official Contentsquare mobile SDKs.

This package keeps the official Contentsquare Capacitor API shape while updating the plugin packaging for Capacitor 8, Swift Package Manager, and Capgo's standard plugin template.

Documentation

The upstream product documentation is available at docs.contentsquare.com/en/capacitor/.

Compatibility

This is a community Capacitor 8 port. Contentsquare's official package currently targets Capacitor 7, but the documented API surface remains the same.

Install

You can use our AI-Assisted Setup to install the plugin. Add the Capgo skills to your AI tool using the following command:

npx skills add https://github.com/cap-go/capacitor-skills --skill capacitor-plugins

Then use the following prompt:

Use the `capacitor-plugins` skill from `cap-go/capacitor-skills` to install the `@capgo/capacitor-contentsquare` plugin in my project.

If you prefer Manual Setup, install the plugin by running the following commands and follow the platform-specific instructions below:

bun add @capgo/capacitor-contentsquare
bunx cap sync

Usage

import { ContentsquarePlugin, CurrencyCode } from '@capgo/capacitor-contentsquare';

await ContentsquarePlugin.optIn();

await ContentsquarePlugin.sendScreenName('Home');

await ContentsquarePlugin.sendTransaction({
  transactionValue: 10,
  transactionCurrency: CurrencyCode.EUR,
  transactionId: 'order-42',
});

await ContentsquarePlugin.sendDynamicVar({
  dynVarKey: 'store',
  dynVarValue: 'rome',
});

iOS Setup

To enable Contentsquare in-app features on iOS, your host app still needs the upstream deeplink wiring described in the official docs:

1. Add the cs-$(PRODUCT_BUNDLE_IDENTIFIER) URL scheme to the app.
2. Forward incoming Contentsquare URLs with Contentsquare.handle(url: url) from your AppDelegate, SceneDelegate, or SwiftUI onOpenURL.

API

optIn() => Promise<void>

optOut() => Promise<void>

sendScreenName(name: string) => Promise<void>

sendTransaction(transactionItem: TransactionItem) => Promise<void>

sendDynamicVar(dynamicVarItem: DynamicVarItem) => Promise<void>

excludeURLForReplay(url: string) => Promise<void>

setPIISelectors(pii: PIIConfig) => Promise<void>

setCapturedElementsSelector(elements: string) => Promise<void>