UserProfileView: Support embedding in an existing NavigationStack (avoid nested NavigationStack)

[matthew-dubois]

Description

UserProfileView unconditionally wraps its content in a NavigationStack (line 141 of UserProfileView.swift). This means it cannot be pushed onto an existing NavigationStack via NavigationLink without creating nested NavigationStacks, which causes broken/missing transition animations for internal navigation (e.g., tapping Profile or Security).

Current behavior

When UserProfileView is pushed via NavigationLink from a parent NavigationStack, sub-page navigation (Profile, Security) has no transition animation — the destination view appears instantly without sliding in.

Expected behavior

UserProfileView should work correctly when pushed onto an existing navigation stack, with proper transition animations for internal navigation.

Suggested solution

Add an option to opt out of the internal NavigationStack, for example:

public init(isDismissable: Bool = true, wrapsInNavigationStack: Bool = true)

When wrapsInNavigationStack is false, the view would use the parent's NavigationStack and register its destinations via .navigationDestination(for:) instead of creating its own.

Workaround

Present UserProfileView in a .sheet instead of pushing via NavigationLink, so the internal NavigationStack is the only one.

Environment

• clerk-ios (Swift SDK)
• iOS 17+/SwiftUI

[seanperez29]

Hey @matthew-dubois! Thanks for reaching out! I've been exploring what options we may have to accomplish this feature, and as of right now I'm leaning a bit towards this route:

public init(isDismissable: Bool = true, navigationPath: Binding<NavigationPath>? = nil)

Since our UserProfileView has views that we need to push onto the stack, if it no longer wraps in a NavigationStack we'd still need access to a NavigationPath to ensure that happens.

If you don't mind, could you share a bit more about the structure of your app and how this feature fits into that? I'd love to learn more about the issue you're facing, in regards to your specific flows, so that I can get a better sense of what others may be facing if they attempt something similar.

Looking forward to hearing about it! Thanks!

[matthew-dubois]

@seanperez29 thanks for the reply! That does seem like the best option...we noticed than when we presented the Clerk UserProfileView as a destination in an existing NavigationStack (eg in the Settings tab of our app or similar), then tapping on an option (which should present a detail view with the OS-handled transition) just jumped to whatever detail view that was (eg Security). We did some digging in the clerk-ios package and seems like the issue is due to that duplicate/nested nav stack. Our workaround right now is to present the UserProfileView in a sheet so theres not a double-NavigationStack, which isn't horrible, just wanted to share! Thanks!

[seanperez29]

@matthew-dubois Awesome, thanks for the details! Glad to hear you have a workaround for the time being. I will continue to look into getting a solution up though, and will keep you updated when I do!