OrganizationProfileView

fun OrganizationProfileView(modifier: Modifier = Modifier, clerkTheme: ClerkTheme? = null, isDismissible: Boolean = true, customRows: List<OrganizationProfileCustomRow> = emptyList(), customDestination: @Composable (String) -> Unit? = null, onDismiss: () -> Unit? = null, onComplete: () -> Unit? = null)

Organization profile view for managing the active organization.

Custom rows are inserted into the root organization profile screen based on their placement; see com.clerk.ui.organizationprofile.custom.OrganizationProfileCustomRowPlacement. When tapped, the matching customDestination composable is rendered. Custom destinations participate in the navigation back stack and survive activity recreation.

When your own navigation takes this view off screen and saves its state, as Navigation Compose, Navigation 3 and Fragment back stacks do, the view comes back on the screen it was showing. Its in-progress input comes back too when the destination has its own ViewModelStoreOwner: a Navigation Compose destination, a Navigation 3 entry with rememberViewModelStoreNavEntryDecorator(), or a Fragment. When the view's ViewModelStoreOwner is the Activity, its ViewModels are cleared when it leaves composition, so it comes back with new ViewModels and the input is lost.

Parameters

clerkTheme

Optional theme customization for the organization profile UI.

isDismissible

Whether to show a top-level back affordance that calls onDismiss.

customRows

Custom rows to display on the profile root screen.

customDestination

Composable that renders the destination for a given route key. The route key matches OrganizationProfileCustomRow.routeKey of the tapped row.

onDismiss

Callback when the organization profile view is dismissed. When omitted, top-level dismissal falls back to the system back dispatcher.

onComplete

Callback when a destructive organization action completes and the profile can no longer be shown. When omitted, the resolved onDismiss handler is used.