components/dev.fritz2.components.appFrame/AppFrameComponent

AppFrameComponent

open class AppFrameComponent : Component<Unit> , CloseButtonProperty
Content copied to clipboard

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

Link copied to clipboard
fun AppFrameComponent()
Content copied to clipboard

Types

Link copied to clipboard
object Companion
Content copied to clipboard

Functions

Link copied to clipboard
fun actions(    styling: Style<BoxParams>? = null,     baseClass: StyleClass = StyleClass.None,     id: String? = null,     context: Tag<HTMLElement>.() -> Unit)
Content copied to clipboard
Link copied to clipboard
fun brand(    styling: Style<FlexParams>? = null,     baseClass: StyleClass = StyleClass.None,     id: String? = null,     context: Tag<HTMLElement>.() -> Unit)
Content copied to clipboard
Link copied to clipboard
fun complementary(    styling: Style<BoxParams>? = null,     baseClass: StyleClass = StyleClass.None,     id: String? = null,     context: Tag<HTMLElement>.() -> Unit)
Content copied to clipboard
Link copied to clipboard
fun content(    styling: Style<BoxParams>? = null,     baseClass: StyleClass = StyleClass.None,     id: String? = null,     context: Tag<HTMLElement>.() -> Unit)
Content copied to clipboard
Link copied to clipboard
fun header(    styling: Style<FlexParams>? = null,     baseClass: StyleClass = StyleClass.None,     id: String? = null,     context: Tag<HTMLElement>.() -> Unit)
Content copied to clipboard
Link copied to clipboard
fun mobileSidebarWidth(value: Int)
Content copied to clipboard

sets the min-with of mobile sidebar

fun mobileSidebarWidth(value: String)
Content copied to clipboard

sets the min-width of sidebar

Link copied to clipboard
fun navigation(    styling: Style<BoxParams>? = null,     baseClass: StyleClass = StyleClass.None,     id: String? = null,     context: Tag<HTMLElement>.() -> Unit)
Content copied to clipboard
Link copied to clipboard
open override fun render(    context: RenderContext,     styling: BoxParams.() -> Unit,     baseClass: StyleClass,     id: String?,     prefix: String)
Content copied to clipboard

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

Link copied to clipboard
fun sidebarWidth(value: Int)
Content copied to clipboard
fun sidebarWidth(value: String)
Content copied to clipboard

sets the min-width of sidebar

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

Properties

Link copied to clipboard
open override val closeButtonIcon: ComponentProperty<Icons.() -> IconDefinition>
Content copied to clipboard
Link copied to clipboard
open override val closeButtonPrefix: String
Content copied to clipboard
Link copied to clipboard
open override val closeButtonRendering: ComponentProperty<RenderContext.() -> DomListener<MouseEvent, HTMLElement>>
Content copied to clipboard
Link copied to clipboard
open override val closeButtonStyle: ComponentProperty<Style<BasicParams>>
Content copied to clipboard
Link copied to clipboard
val closeSidebar: SimpleHandler<Unit>
Content copied to clipboard
Link copied to clipboard
open override val hasCloseButton: ComponentProperty<Boolean>
Content copied to clipboard
Link copied to clipboard
val sidebarToggle: ComponentProperty<PushButtonComponent.() -> Unit>
Content copied to clipboard