NavLinkComponent

@ExperimentalCoroutinesApi()

open class NavLinkComponent : Component<Listener<MouseEvent>>

This class combines the configuration and the core rendering of an appFrame navigation-link.

You can configure the

icon
text
active state

The rendering function is used by the component factory functions navLink, so it is not meant to be called directly unless you plan to implement your own navLink.

Constructors

NavLinkComponent

fun NavLinkComponent()

Types

Companion

object Companion

Functions

equals

open operator fun equals(other: Any?): Boolean

hashCode

open fun hashCode(): Int

render

open override fun render(context: RenderContext, styling: BoxParams.() -> Unit, baseClass: StyleClass, id: String?, prefix: String): Listener<MouseEvent>

Central method that should do the actual rendering of a component.

toString

open fun toString(): String

Properties

active

val active: ComponentProperty<Flow<Boolean>?>

icon

val icon: ComponentProperty<IconComponent.() -> Unit>

text

val text: DynamicComponentProperty<String>