Compose SwiftUIv0.4.0
esc
GuideAPIGitHub
View

NavigationLink

The Compose SwiftUI form of SwiftUI's NavigationLink.

iOS 17.0+macOS 14.0+tvOS 17.0+watchOS 10.0+
fun NavigationLink(title: String, value: Any?, modifier: Modifier = Modifier)

Overview

NavigationLink(title = "…", value = value)

This is the Kotlin form of SwiftUI NavigationLink.init(_:value:): SwiftUI documentation. In Swift it reads:

nonisolated init<S, P>(_ title: S, value: P?) where Label == Text, S : StringProtocol, P : Hashable

Topics

Creating a NavigationLink

fun NavigationLink(modifier: Modifier = Modifier, destination: @Composable () -> Unit, label: @Composable () -> Unit)
SwiftUI NavigationLink.init(destination:label:)
fun NavigationLink(destinationName: String, tag: Any, selection: Any?, modifier: Modifier = Modifier, onSelectionChange: (Any?) -> Unit, content: @Composable () -> Unit)
SwiftUI NavigationLink.init(destinationName:tag:selection:label:) · iOS: unavailable (no-op), macOS: unavailable (no-op), tvOS: unavailable (no-op), watchOS 10.0+
fun NavigationLink(destinationName: String, modifier: Modifier = Modifier, content: @Composable () -> Unit)
SwiftUI NavigationLink.init(destinationName:label:) · iOS: unavailable (no-op), macOS: unavailable (no-op), tvOS: unavailable (no-op), watchOS 10.0+
fun NavigationLink(destinationName: String, isActive: Boolean, modifier: Modifier = Modifier, onIsActiveChange: (Boolean) -> Unit, content: @Composable () -> Unit)
SwiftUI NavigationLink.init(destinationName:isActive:label:) · iOS: unavailable (no-op), macOS: unavailable (no-op), tvOS: unavailable (no-op), watchOS 10.0+
fun NavigationLink(value: Any?, modifier: Modifier = Modifier, content: @Composable () -> Unit)
SwiftUI NavigationLink.init(value:label:)
fun NavigationLink(title: String, value: Any?, modifier: Modifier = Modifier)
SwiftUI NavigationLink.init(_:value:)
fun NavigationLink(titleResource: LocalizedKey, modifier: Modifier = Modifier, content: @Composable () -> Unit)
SwiftUI NavigationLink.init(_:destination:)
fun NavigationLink(titleResource: LocalizedKey, value: Any?, modifier: Modifier = Modifier)
SwiftUI NavigationLink.init(_:value:)
fun NavigationLink(tag: Any, selection: Any?, modifier: Modifier = Modifier, onSelectionChange: (Any?) -> Unit, destination: @Composable () -> Unit, label: @Composable () -> Unit)
SwiftUI NavigationLink.init(tag:selection:destination:label:)
fun NavigationLink(isActive: Boolean, modifier: Modifier = Modifier, onIsActiveChange: (Boolean) -> Unit, destination: @Composable () -> Unit, label: @Composable () -> Unit)
SwiftUI NavigationLink.init(isActive:destination:label:)
fun NavigationLink(titleKey: LocalizedKey, tag: Any, selection: Any?, modifier: Modifier = Modifier, onSelectionChange: (Any?) -> Unit, content: @Composable () -> Unit)
SwiftUI NavigationLink.init(_:tag:selection:destination:)
fun NavigationLink(titleKey: LocalizedKey, isActive: Boolean, modifier: Modifier = Modifier, onIsActiveChange: (Boolean) -> Unit, content: @Composable () -> Unit)
SwiftUI NavigationLink.init(_:isActive:destination:)
fun NavigationLink(value: Any? = null, title: String? = null, titleResource: LocalizedKey? = null, tag: Any? = null, selection: Any? = null, isActive: Boolean? = null, modifier: Modifier = Modifier, onSelectionChange: ((Any?) -> Unit)? = null, onIsActiveChange: ((Boolean) -> Unit)? = null, content: (@Composable () -> Unit)? = null)
SwiftUI NavigationLink · (e.g. Image(systemName = SFSymbol.star)).

Methods

fun NavigationLinkValue(value: Any?, modifier: Modifier = Modifier, content: @Composable () -> Unit)
SwiftUI NavigationLink.init(value:label:)
fun NavigationLinkValue(title: String, value: Any?, modifier: Modifier = Modifier)
SwiftUI NavigationLink.init(_:value:)
fun NavigationLinkValue(titleResource: LocalizedKey, value: Any?, modifier: Modifier = Modifier)
SwiftUI NavigationLink.init(_:value:)
fun NavigationLinkTag(title: String, tag: Any, selection: Any?, modifier: Modifier = Modifier, onSelectionChange: (Any?) -> Unit, content: @Composable () -> Unit)
SwiftUI NavigationLink.init(_:tag:selection:destination:)
fun NavigationLinkIsActive(title: String, isActive: Boolean, modifier: Modifier = Modifier, onIsActiveChange: (Boolean) -> Unit, content: @Composable () -> Unit)
SwiftUI NavigationLink.init(_:isActive:destination:)