kilua-routing/dev.kilua.routing

Package-level declarations

Types

A base interface for routing builders. Provides methods to define routes, views, actions, and metadata.

abstract class BaseRoutingBuilderImpl : BaseRoutingBuilder

An abstract base implementation of the BaseRoutingBuilder interface. Provides common functionality for routing builders.

IntRoutingBuilder

interface IntRoutingBuilder : BaseRoutingBuilder

A routing builder interface for numeric routes.

IntRoutingBuilderImpl

class IntRoutingBuilderImpl : BaseRoutingBuilderImpl, IntRoutingBuilder

An implementation of the IntRoutingBuilder interface for numeric routes. Provides methods to define views and actions for routes with numeric parameters.

IntRoutingContext

interface IntRoutingContext : RoutingContext

Represents a routing context that holds a numeric value.

IntRoutingContextImpl

class IntRoutingContextImpl : RoutingContextImpl, IntRoutingContext

Default implementation of IntRoutingContext. Holds a numeric value that can be accessed within the routing context.

Meta

interface Meta

Represents metadata for a web page, including title, description, author, and more.

MetaImpl

@Serializable

class MetaImpl : Meta

Default implementation of the Meta interface.

OpenGraph

@Serializable

data class OpenGraph(var title: String? = null, var description: String? = null, var images: List<OpenGraphImage>? = null, var type: String? = null, var url: String? = null, var locale: String? = null, var siteName: String? = null)

Represents Open Graph metadata for a web page.

OpenGraphImage

@Serializable

data class OpenGraphImage(var url: String, var width: Int? = null, var height: Int? = null, var alt: String? = null)

Represents an Open Graph image with optional width, height, and alt text.

PlainRoutingBuilder

interface PlainRoutingBuilder : BaseRoutingBuilder

A routing builder interface for given path routes.

PlainRoutingBuilderImpl

open class PlainRoutingBuilderImpl : BaseRoutingBuilderImpl, PlainRoutingBuilder

An implementation of the PlainRoutingBuilder interface for plain routes. Provides methods to define views and actions for routes without parameters.

Robots

@Serializable

data class Robots(var noindex: Boolean = false, var nofollow: Boolean = false, var noarchive: Boolean = false, var nosnippet: Boolean = false, var noimageindex: Boolean = false)

Represents robots meta tags for controlling indexing and crawling behavior.

Route

sealed class Route

A model for an application route.

RoutingBuilder

interface RoutingBuilder : BaseRoutingBuilder

A routing builder interface for entry route.

RoutingBuilderImpl

open class RoutingBuilderImpl : BaseRoutingBuilderImpl, RoutingBuilder

An implementation of the RoutingBuilder interface for entry routes. Provides methods to define default content, metadata, views, and actions.

RoutingContext

interface RoutingContext

Represents the context of a routing operation, providing access to the current path, remaining path and parameters.

RoutingContextImpl

open class RoutingContextImpl : RoutingContext

Default implementation of RoutingContext. Provides properties for path, remaining path and parameters.

RoutingDsl

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

@DslMarker

annotation class RoutingDsl

A marker for routing DSL.

RoutingModel

class RoutingModel(val routes: List<Route>? = null, defaultContent: @Composable IComponent.() -> Unit? = null, val defaultMeta: Meta?, notFoundView: @Composable IComponent.() -> Unit? = null, notFoundAction: suspend () -> Unit? = null, val notFoundMeta: Meta?)

The routing tree model.

StringRoutingBuilder

interface StringRoutingBuilder : BaseRoutingBuilder

A routing builder interface for string routes.

StringRoutingBuilderImpl

class StringRoutingBuilderImpl : BaseRoutingBuilderImpl, StringRoutingBuilder

An implementation of the StringRoutingBuilder interface for string routes. Provides methods to define views and actions for routes with string parameters.

StringRoutingContext

interface StringRoutingContext : RoutingContext

Represents a routing context that holds a string value.

StringRoutingContextImpl

class StringRoutingContextImpl : RoutingContextImpl, StringRoutingContext

Default implementation of StringRoutingContext. Holds a string value that can be accessed within the routing context.