components/dev.fritz2.components/AppFrameComponent

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

fun AppFrameComponent()

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)

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

toString

open fun toString(): String

Properties

actions

val actions: ComponentProperty<RenderContext.() -> Unit>

brand

val brand: ComponentProperty<Div.() -> Unit>

footer

val footer: ComponentProperty<TextElement.() -> Unit?>

header

val header: ComponentProperty<RenderContext.() -> Unit>

main

val main: ComponentProperty<TextElement.() -> Unit>

nav

val nav: ComponentProperty<TextElement.() -> Unit>

sidebarToggle

val sidebarToggle: ComponentProperty<RenderContext.(SimpleHandler<Unit>) -> Unit>

tabs

val tabs: ComponentProperty<Div.() -> Unit?>