AppFrameComponent

@ExperimentalCoroutinesApi()
open class AppFrameComponent : Component<Unit>

This class combines the configuration and the core rendering of the app-frame.

You can configure the content of the following sections

  • brand

  • header

  • actions

  • nav

  • main

  • footer (only rendered if defined)

  • tabs (only rendered if defined)

In addition to that you can define how the sidebarToggle on small screens is rendered. By default is a hamburger-button.

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

Constructors

AppFrameComponent
Link copied to clipboard
js
fun AppFrameComponent()

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)
Central method that should do the actual rendering of a component.
toString
Link copied to clipboard
js
open fun toString(): String

Properties

actions
Link copied to clipboard
js
val actions: ComponentProperty<RenderContext.() -> Unit>
brand
Link copied to clipboard
js
val brand: ComponentProperty<Div.() -> Unit>
footer
Link copied to clipboard
js
val footer: ComponentProperty<TextElement.() -> Unit?>
header
Link copied to clipboard
js
val header: ComponentProperty<RenderContext.() -> Unit>
main
Link copied to clipboard
js
val main: ComponentProperty<TextElement.() -> Unit>
nav
Link copied to clipboard
js
val nav: ComponentProperty<TextElement.() -> Unit>
sidebarToggle
Link copied to clipboard
js
val sidebarToggle: ComponentProperty<RenderContext.(SimpleHandler<Unit>) -> Unit>
tabs
Link copied to clipboard
js
val tabs: ComponentProperty<Div.() -> Unit?>