AppFrameComponent

open class AppFrameComponent : Component<Unit> , CloseButtonProperty

This class combines the configuration and the core rendering of the appFrame.

You can configure the content of the following sections

brand
header
actions
navigation
content
complementary (only rendered if defined)
tablist (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

actions

fun actions(styling: Style<BoxParams>? = null, baseClass: StyleClass = StyleClass.None, id: String? = null, context: Tag<HTMLElement>.() -> Unit)

brand

fun brand(styling: Style<FlexParams>? = null, baseClass: StyleClass = StyleClass.None, id: String? = null, context: Tag<HTMLElement>.() -> Unit)

complementary

fun complementary(styling: Style<BoxParams>? = null, baseClass: StyleClass = StyleClass.None, id: String? = null, context: Tag<HTMLElement>.() -> Unit)

content

fun content(styling: Style<BoxParams>? = null, baseClass: StyleClass = StyleClass.None, id: String? = null, context: Tag<HTMLElement>.() -> Unit)

header

fun header(styling: Style<FlexParams>? = null, baseClass: StyleClass = StyleClass.None, id: String? = null, context: Tag<HTMLElement>.() -> Unit)

mobileSidebarWidth

fun mobileSidebarWidth(value: Int)

sets the min-with of mobile sidebar

fun mobileSidebarWidth(value: String)

sets the min-width of sidebar

navigation

fun navigation(styling: Style<BoxParams>? = null, baseClass: StyleClass = StyleClass.None, id: String? = null, context: Tag<HTMLElement>.() -> Unit)

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.

sidebarWidth

fun sidebarWidth(value: Int)

sets the min-width of sidebar

fun sidebarWidth(value: String)

sets the min-width of sidebar

tablist

fun tablist(styling: Style<FlexParams>? = null, baseClass: StyleClass = StyleClass.None, id: String? = null, context: Tag<HTMLElement>.() -> Unit)

Properties

closeButtonIcon

open override val closeButtonIcon: ComponentProperty<Icons.() -> IconDefinition>

closeButtonPrefix

open override val closeButtonPrefix: String

closeButtonRendering

open override val closeButtonRendering: ComponentProperty<RenderContext.() -> DomListener<MouseEvent, HTMLElement>>

closeButtonStyle

open override val closeButtonStyle: ComponentProperty<Style<BasicParams>>

closeSidebar

val closeSidebar: SimpleHandler<Unit>

hasCloseButton

open override val hasCloseButton: ComponentProperty<Boolean>

sidebarToggle

val sidebarToggle: ComponentProperty<PushButtonComponent.() -> Unit>