0.21.1

kobweb-core/com.varabyte.kobweb.navigation

Package-level declarations

Types

interface BasePath

Represents a subpath under which the user's entire site is served under.

ErrorPageMethod

typealias ErrorPageMethod = @Composable (Int) -> Unit

Typealias for a composable method which takes an error code as its first and only argument (e.g. 404).

OpenLinkStrategy

enum OpenLinkStrategy : Enum<OpenLinkStrategy>

typealias PageMethod = @Composable (PageContext) -> Unit

class Route(pathQueryAndFragment: String)

A path component to a relative or absolute URL string without a domain, e.g. "/example/path" or "example/path".

class RouteException(value: String) : Exception

RouteInterceptorScope

class RouteInterceptorScope(pathQueryAndFragment: String)

Scope provided backing the handler for Router.addRouteInterceptor.

typealias ~~RoutePrefix~~ = BasePath

class Router

The class responsible for navigating to different pages in a user's app.

UpdateHistoryMode

enum UpdateHistoryMode : Enum<UpdateHistoryMode>

How to affect the current history when navigating to a new location

Properties

val Route.slug: String

Functions

@Composable

fun Anchor(href: String, attrs: AttrBuilderContext<HTMLAnchorElement>? = null, openInternalLinksStrategy: OpenLinkStrategy? = null, openExternalLinksStrategy: OpenLinkStrategy? = null, updateHistoryMode: UpdateHistoryMode? = null, content: ContentBuilder<HTMLAnchorElement>? = null)

A special version of the A tag which, when clicked on, will not reload the current page if it's within the same site.

fun Window.open(href: String, strategy: OpenLinkStrategy)

fun BasePath.Companion.prependIf(condition: Boolean, path: String): String

Conditionally prepend the base path only if the passed in condition is true.

fun BasePath.Companion.remove(path: String): String

Remove the base path from some target absolute path (relative paths will be returned as is).

toOpenLinkStrategy

fun SyntheticMouseEvent.toOpenLinkStrategy(default: OpenLinkStrategy = OpenLinkStrategy.IN_PLACE): OpenLinkStrategy

Convert a mouse event plus control key state to an OpenLinkStrategy.