镜像站点 · 本页由第三方 GitHub 只读镜像提供,非 GitHub 官方站点,不接受任何登录或凭据输入。前往 github.com
Skip to content
formbricksPublic

About

Formbricks iOS SDK

Resources

Stars

5 stars

Watchers

0 watching

Forks

Repository files navigation

Formbricks iOS SDK

The iOS SDK for Formbricks

Installation

Swift Package Manager

  1. In Xcode choose File → Add Packages…
  2. Enter https://github.com/formbricks/ios.git.
  3. Choose version rule (e.g. "Up to Next Major" starting at 2.3.0).
  4. Add the FormbricksSDK library product to your app target.
  5. Import in your code:
    import FormbricksSDK

Migrating from CocoaPods

New FormbricksSDK releases are distributed through Swift Package Manager only. CocoaPods Trunk is becoming read-only, with a test period on November 1–7, 2026 and a permanent switch on December 2, 2026. Previously published pod versions remain available; migrate to receive future SDK updates.

  1. Remove the pod 'FormbricksSDK', ... entry from every target in your Podfile.
  2. Run pod install to update the workspace and lockfile. Keep any other pods your app uses.
  3. Follow the Swift Package Manager instructions above and add FormbricksSDK to each app target that uses it. Do not link both the pod and the Swift package in the same target.
  4. Keep import FormbricksSDK and your existing SDK calls. Build and test your app after switching. If you also upgrade the SDK version, review its release notes.

Quickstart

import FormbricksSDK

// 1. Build your config (you can also inject userId + attributes here)
let config = FormbricksConfig.Builder(
        appUrl: "https://your‑app.bricks.com",
        workspaceId: "YOUR_WORKSPACE_ID"
    )
    .setLogLevel(.debug)
    .build()

// Note: `environmentId` is still supported as a deprecated alias for
// `workspaceId` and will be removed in a future release.
// Existing integrations using `environmentId` continue to work:
//
//   FormbricksConfig.Builder(
//       appUrl: "https://your‑app.bricks.com",
//       environmentId: "YOUR_ENV_ID" // deprecated, use workspaceId
//   )

// 2. Initialize the SDK (once per launch)
Formbricks.setup(with: config)

// 3. Identify the user
Formbricks.setUserId("user‑123")

// 4. Track events
Formbricks.track("button_pressed")

// 5. Set or add user attributes
Formbricks.setAttribute("blue", forKey: "favoriteColor")
Formbricks.setAttributes([
    "plan": "pro",
    "tier": "gold"
])

// 6. Change language (no userId required):
Formbricks.setLanguage("de")

// 7. Log out (no userId required):
Formbricks.logout()

// 8. Clean up SDK state (optional):
Formbricks.cleanup(waitForOperations: true) {
    print("SDK torn down")
}

Dark mode

Surveys render light by default. Call setAppearance to change it:

Formbricks.setAppearance(.dark) // .light, .dark or .system
  • Works before or after setup, or pass it in the config with .set(appearance: .dark). Objective-C: [Formbricks setAppearance:@"dark"].
  • An open survey switches in place; the typed answer and current question stay.
  • .system follows your app's theme (including overrideUserInterfaceStyle), not the phone's, and updates live.
  • Kept across logout(), forgotten on app restart, never sent to the server. An unknown value is logged and falls back to light.
  • Needs a Formbricks server that supports dark mode; an older server keeps surveys light.

Custom CSS configured in Formbricks needs no SDK call; it arrives with the workspace state.

Releasing

  1. Confirm the SonarQube workflow passes, including the iOS simulator tests.
  2. Create a new semantic-version Git tag (for example, 2.3.1) on the tested commit and publish a GitHub release with the changes and any upgrade instructions. Do not move existing release tags.
  3. Swift Package Manager discovers versions from Git tags; no separate registry publishing step is required. Verify the new version resolves in Xcode and build an app that imports FormbricksSDK.

About

Formbricks iOS SDK

Resources

Stars

5 stars

Watchers

0 watching

Forks

Releases

Packages

Used by

Contributors

Languages