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
Link copied to clipboard
js
fun NavLinkComponent()

Types

Companion
Link copied to clipboard
js
object Companion

Functions

equals
Link copied to clipboard
js
open operator fun equals(other: Any?): Boolean
hashCode
Link copied to clipboard
js
open fun hashCode(): Int
render
Link copied to clipboard
js
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
Link copied to clipboard
js
open fun toString(): String

Properties

active
Link copied to clipboard
js
val active: ComponentProperty<Flow<Boolean>?>
icon
Link copied to clipboard
js
val icon: ComponentProperty<IconComponent.() -> Unit>
text
Link copied to clipboard
js
val text: DynamicComponentProperty<String>