Skip to content

Add Signals SwiftUI info #6645

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Jun 3, 2024
Merged

Add Signals SwiftUI info #6645

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
d14bc71
fix: add note for Swiftui projects to setup doc
alanjcharles Jun 3, 2024
2746ed3
fix: update cli line in live plugin setup
alanjcharles Jun 3, 2024
05ce54b
Change to header
pwseg Jun 3, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 16 additions & 1 deletion src/connections/auto-instrumentation/setup.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,21 @@ Follow these steps to integrate the Signals SDK into your Swift application:

Verify that you replaced `<WRITE_KEY>` with the actual write key you copied in Step 1.

#### SwiftUI projects

If your app is written in SwiftUI, you'll need to add a `TypeAlias.swift` file to your project that captures interaction and navigation Signals, like in this example:
```swift
import Foundation
import Signals
typealias Button = SignalButton
typealias NavigationStack = SignalNavigationStack
typealias NavigationLink = SignalNavigationLink
typealias TextField = SignalTextField
typealias SecureField = SignalSecureField
```
### Kotlin
Follow these steps to integrate the Signals SDK into your Kotlin application:
Expand Down Expand Up @@ -136,4 +151,4 @@ Redeployment ensures that the new rules are active and that your application can
## Next steps
This guide walked you through initial Signals SDK/Auto-Instrumentation setup. Next, read the [Auto-Instrumentation Signals Implementation Guide](/docs/connections/auto-instrumentation/configuration/), which dives deeper into Signals and offers examples rules.
This guide walked you through initial Signals SDK/Auto-Instrumentation setup. Next, read the [Auto-Instrumentation Signals Implementation Guide](/docs/connections/auto-instrumentation/configuration/), which dives deeper into Signals and offers examples rules.
2 changes: 1 addition & 1 deletion src/connections/sources/catalog/libraries/mobile/apple/live-plugins.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -100,7 +100,7 @@ Next, you'll authenticate with Segment to give the CLI access to your workspace:
7. Use your source ID and live plugin file name to upload your live plugin:
```shell
$ segmentcli upload <SourceID> <FileName>
$ segmentcli liveplugins upload <SourceID> <FileName>
```
You've now successfully attached your live plugin(s) to your mobile source. The next time your users launch your app, their Segment SDK will download the latest live plugins, which will run every time new events are generated.
Expand Down