navigation-compose-extended-annotation/dev.sergiobelda.navigation.compose.extended.annotation

Package-level declarations

Types

@Target(allowedTargets = [AnnotationTarget.ANNOTATION_CLASS])

annotation class NavArgument(val name: String, val type: NavArgumentType = NavArgumentType.String, val nullable: Boolean = false, val defaultValue: String = "")

Represents a navigation argument in a navigation destination. Using this annotation will generate a NavArgumentKey entry in the navigation destination and will register this argument in the navigation destination's arguments list.

NavArgumentType

enum NavArgumentType : Enum<NavArgumentType>

NavArgument valid types.

NavDestination

@Target(allowedTargets = [AnnotationTarget.FUNCTION, AnnotationTarget.CLASS])

annotation class NavDestination(val destinationId: String, val name: String = "", val isTopLevelNavDestination: Boolean = false, val arguments: Array<NavArgument> = [], val deepLinkUris: Array<String> = [])

Represents a navigation destination in the Navigation graph. Annotating a function or expression with this annotation will generate a NavDestination object for this function. You must set a destinationId that will be used to identify this destination. The function name will be used as the navigation destination unless you set a name value. You can indicate that this navigation destination is a top-level destination by setting isTopLevelNavDestination to true. deepLinkUris is a list of deep links that will be associated with this navigation destination. In addition, an enum class that contains the navigation arguments keys will be generated and a SafeNavArgs class to access to the argument values.