iOS SDK

Last updated September 4, 2026

Integrate WishKit (in-app feature request / feedback board) into this codebase.

## Goal
Add the WishKit SDK so users can submit and vote on feature requests from inside the app. Place the feedback board where users will find it. Tint WishKit with the app’s accent color only where it helps. Do not run a full product build for the user — leave building and running the app to them.

## Project details
- WishKit project name: your project
- WishKit API key (required — use this exact value): YOUR_API_KEY
- Docs / package: https://github.com/wishkit/wishkit-ios
- SPM package URL: https://github.com/wishkit/wishkit-ios.git
- Prefer the latest WishKit SDK (v5+). SwiftUI-only API.

## First: identify the app
- Inspect the project and determine which platform this app is for (iOS, macOS, visionOS, watchOS, or tvOS). An app is typically one primary platform — do not assume multi-platform.
- Integrate only for the platform and target structure you find. Follow platform-specific notes that apply to that platform only.

## Requirements

### 1. Add the package
- Add the Swift Package: https://github.com/wishkit/wishkit-ios.git
- Link the WishKit product to the app target that should show the feedback board.

### 2. Network / sandbox
- WishKit needs outgoing network access for API calls.
- If this is a macOS app with App Sandbox enabled: turn on Outgoing Connections (Client) (com.apple.security.network.client). Without it, network requests fail under sandbox.
- For iOS and similar platforms: normal HTTPS outbound access is enough; only fix custom ATS rules if they would block the API.
- Do not ask the user to build the project as part of your work; just apply the entitlement/settings in the project files when needed.

### 3. Configure WishKit early
In the app entry or first root view (e.g. App init or root View init):

import WishKit

WishKit.configure(with: "YOUR_API_KEY")

Do not invent a different API key.

### 4. Accent color only
- Optionally set WishKit.theme.primaryColor to match the app’s accent / brand accent (vote button, primary actions).
- Do not set secondary or tertiary / background colors for the feedback board. Leave backgrounds to WishKit defaults so it stays native.
- Prefer Color.accentColor or an existing accent asset if that matches the app.

### 5. Present the feedback board prominently
Use WishKit.FeedbackListView() (on iOS/tvOS add .withNavigation() modifier if not already inside a NavigationStack).

Placement priority (pick the first that fits this app):
1. Tab bar — if there is no Settings but there is a TabView / tab bar, add a tab with a lightbulb SF Symbol (lightbulb / lightbulb.fill) labeled only "Feedback" or "Feature Requests".
2. Settings — if the app has a Settings screen, add a button or tappable row labeled only "Feedback" or "Feature Requests" that opens the WishKit list.
3. Otherwise — a visible toolbar or menu entry labeled only "Feedback" or "Feature Requests".

Use only those two labels ("Feedback" or "Feature Requests"). Do not use "Ideas" or other names.
Do not bury the entry behind obscure menus.

### 6. User email and payments (when the app already has them)
- If the app already knows or can access the signed-in user’s email, pass it to WishKit with WishKit.updateUser(email: ...).
- If the app knows whether a user pays for a premium / subscription (and how much, e.g. monthly or yearly), pass that with WishKit.updateUser(payment: ...) (weekly, monthly, or yearly as appropriate). Only do this when the app already has that data — do not invent payment flows.
- If the app already knows or can access name or custom user id, pass that via WishKit.updateUser(name:) / WishKit.updateUser(customID:).

### 7. Platform-specific notes (apply only what matches the app you identified)
- Supported by the SDK: iOS 16+, macOS 13+, visionOS 1+, watchOS 10+, tvOS 17+.
- iOS/tvOS: WishKit.FeedbackListView().withNavigation() when not already in a NavigationStack.
- macOS / visionOS / watchOS: WishKit provides its own navigation; no extra wrap.
- watchOS/tvOS: more limited (browse + vote); still wire up what the platform supports.

### 8. When you are done
- Summarize what you changed (files, entry point, any sandbox entitlement).
- Do not run xcodebuild / full app builds unless the user asks.
- End with a short "Did you know?" list of optional capabilities, for example:
  1. Allow undoing a vote (WishKit.config.allowUndoVote = true)
  2. Change the voting icon (WishKit.config.buttons.voteButton.icon)
  3. Enable or disable comments (WishKit.config.commentSection = .show / .hide)
  4. Show status badges (WishKit.config.statusBadge = .show)
  5. Expand full descriptions in the list (WishKit.config.expandDescriptionInList = true)
  6. Localize UI strings via WishKit.config.localization

Keep that list brief. Docs: https://github.com/wishkit/wishkit-ios

## Constraints
- Minimal, idiomatic changes that match the existing project style.
- Do not remove unrelated features.
- Prefer SwiftUI APIs from WishKit v5 (not UIKit viewController from older docs).

ON THIS PAGE

Install Configure Present the board Placement Identify users Theme and config Platform notes Troubleshooting

A SwiftUI view that renders your feedback board natively on iOS, macOS, visionOS, watchOS and tvOS. Open source at github.com/wishkit/wishkit-ios.

Requirements: Xcode, and a target on iOS 16+, macOS 13+, visionOS 1+, watchOS 10+ or tvOS 17+. Version 5 and later is SwiftUI-only.

Install

In Xcode choose File, Add Package Dependencies, paste the URL, and add the WishKit product to the app target that shows the board.


1 https://github.com/wishkit/wishkit-ios.git

Configure

Call configure once, as early as possible. The App initializer is the usual place. Get the key from your project in the dashboard.


1 import WishKit
2 
3 WishKit.configure(with: "your-api-key")

Present the board

The board is a view. On iOS and tvOS it expects a navigation container; if you are not already inside a NavigationStack, add the modifier that provides one. macOS, visionOS and watchOS bring their own navigation, so use the plain view there.


1 // iOS and tvOS
2 WishKit.FeedbackListView().withNavigation()
3 
4 // macOS, visionOS, watchOS
5 WishKit.FeedbackListView()

From UIKit, wrap it in a hosting controller and push or present it like any other screen:


1 let feedback = UIHostingController(rootView: WishKit.FeedbackListView().withNavigation())
2 present(feedback, animated: true)

Placement

Put the entry point where users look for it, and label it "Feedback" or "Feature Requests". In order of how well they work: a tab with a lightbulb symbol, a row on the settings screen, a toolbar or menu item.


1 WishKit.FeedbackListView().withNavigation()
2     .tabItem { Label("Feedback", systemImage: "lightbulb") }

Identify users

Users vote anonymously by default and their votes stay consistent across launches. If your app knows more, pass it along whenever it changes, for example after sign-in or a purchase. Only pass what you already have.


1 WishKit.updateUser(email: "jane@example.com")
2 WishKit.updateUser(name: "Jane")
3 WishKit.updateUser(customID: "user_8AHD1IL03ACIP")
4 WishKit.updateUser(payment: .monthly(7.99))

The payment value accepts weekly, monthly, or yearly amounts. With it set, the dashboard can sort requests by the revenue of the users who asked.

Theme and config

Set these next to the configure call. Everything is optional; the defaults look native.

Property	What it does
`WishKit.theme.primaryColor`	Accent color for the vote button and primary actions. Use your app's accent color.
`WishKit.theme.secondaryColor`, `tertiaryColor`	Background colors, with light and dark variants. Leave them to the defaults for a native look.
`WishKit.config.allowUndoVote`	Lets a user take a vote back.
`WishKit.config.statusBadge`	`.show` or `.hide` the status badge on each request.
`WishKit.config.commentSection`	`.show` or `.hide` comments in the detail view.
`WishKit.config.expandDescriptionInList`	Shows full descriptions in the list instead of truncating them.
`WishKit.config.buttons.voteButton.icon`	Changes the voting icon.
`WishKit.config.buttons.segmentedControl`	Configures the open and completed segments.
`WishKit.config.translateButton`	On iOS 18 and later, an on-device translate button for requests written in other languages.
`WishKit.config.localization`	Override any string the SDK shows.


1 WishKit.theme.primaryColor = .accentColor
2 WishKit.config.statusBadge = .show
3 WishKit.config.commentSection = .show

Platform notes

macOS with App Sandbox: enable Outgoing Connections (Client) under Signing and Capabilities, or requests fail silently.
visionOS and watchOS: the SDK provides its own navigation; do not add the navigation modifier.
watchOS and tvOS: browsing and voting work; text-heavy actions are naturally limited on these platforms.

Troubleshooting

The board is empty or never loads

Check that configure ran before the view appeared, that the key matches the project in the dashboard, and, on macOS, that the sandbox allows outgoing connections.

Requests appear in the app but not in the dashboard

You are looking at a different project. Each project has its own key and its own board.

The list has no navigation bar on iOS

Add .withNavigation(), or place the view inside your own NavigationStack.

Want the narrative version with screenshots of each step? Read how to add a feedback board to a SwiftUI app.

PreviousOverview NextWeb SDK