Package dev.fritz2.components

Types

CheckboxComponent
Link copied to clipboard
js
class CheckboxComponent
This class combines the configuration and the core styling of a checkbox.
CheckboxGroupComponent
Link copied to clipboard
js
class CheckboxGroupComponent<T>
This class combines the configuration and the core styling of a checkbox group.
ComponentMarker
Link copied to clipboard
js
annotation class ComponentMarker
A marker to separate the layers of calls in the type-safe-builder pattern.
ControlGroupRenderer
Link copied to clipboard
js
class ControlGroupRenderer(component: FormControlComponent) : ControlRenderer
ControlRenderer
Link copied to clipboard
js
interface ControlRenderer
DefaultOverlay
Link copied to clipboard
js
class DefaultOverlay(method: OverlayMethod, styling: Style<BasicParams>) : Overlay
FormControlComponent
Link copied to clipboard
js
open class FormControlComponent
This component class manages the configuration of a formControl and some render centric functionalities.
IconComponent
Link copied to clipboard
js
class IconComponent
Class for configuring the appearance of an icon.
InputFieldComponent
Link copied to clipboard
js
open class InputFieldComponent
This class deals with the configuration of an input element.
LineUpComponent
Link copied to clipboard
js
class LineUpComponent : StackComponent
This component class just defines the core styling in order to render child items within a flexBox layout horizontally.
ModalComponent
Link copied to clipboard
js
class ModalComponent
This component class offers primarily some configuration options for modal dialogs.
ModalRenderContext
Link copied to clipboard
js
typealias ModalRenderContext = RenderContext.(level: Int) -> Div
NavbarComponent
Link copied to clipboard
js
open class NavbarComponent
Overlay
Link copied to clipboard
js
interface Overlay
OverlayMethod
Link copied to clipboard
js
enum OverlayMethod : Enum<OverlayMethod>
PopoverComponent
Link copied to clipboard
js
class PopoverComponent
Class for configuring the appearance of a PopoverComponent.
PushButtonComponent
Link copied to clipboard
js
open class PushButtonComponent
This class combines the configuration and the core rendering of a button.
RadioComponent
Link copied to clipboard
js
class RadioComponent
This class combines the configuration and the core styling of a switch.
RadioGroupComponent
Link copied to clipboard
js
class RadioGroupComponent<T>
This class combines the configuration and the core styling of a radio group.
SingleControlRenderer
Link copied to clipboard
js
class SingleControlRenderer(component: FormControlComponent) : ControlRenderer
SpinnerComponent
Link copied to clipboard
js
class SpinnerComponent
This component class offers different configuration values of a spinner.
StackComponent
Link copied to clipboard
js
abstract class StackComponent
This base component class for stacking components offer some configuration properties.
StackUpComponent
Link copied to clipboard
js
class StackUpComponent : StackComponent
This component class just defines the core styling in order to render child items within a flexBox layout vertically.
Svg
Link copied to clipboard
js
class Svg(id: String?, baseClass: String?, domNode: SVGElement, job: Job) : Tag<SVGElement>
SwitchComponent
Link copied to clipboard
js
class SwitchComponent
This class combines the configuration and the core styling of a switch.
TextAreaComponent
Link copied to clipboard
js
class TextAreaComponent
This class handles the configuration of an textarea elementThe textArea can be configured for the following aspects:
  • the size of the element

  • the direction of resizing

  • some predefined styles

  • a default value

  • the base options of the HTML input element can be set. Attributes

  • For a detailed explanation and examples of usage have a look at the textArea function !

Functions

box
Link copied to clipboard
js
fun RenderContext.box(styling: FlexParams.() -> Unit = {}, baseClass: StyleClass? = null, id: String? = null, prefix: String = "box", init: Div.() -> Unit): Div
This component represents the simplest layout component possible: A simple `div` that acts as a container for arbitrary content.
checkbox
Link copied to clipboard
js
fun RenderContext.checkbox(styling: BasicParams.() -> Unit = {}, baseClass: StyleClass? = null, id: String? = null, prefix: String = "checkboxComponent", build: CheckboxComponent.() -> Unit = {}): Label
This component generates a single checkbox.
checkboxGroup
Link copied to clipboard
js
fun <T> RenderContext.checkboxGroup(styling: BasicParams.() -> Unit = {}, store: Store<List<T>>, baseClass: StyleClass? = null, id: String? = null, prefix: String = "checkboxGroupComponent", build: CheckboxGroupComponent<T>.() -> Unit = {})
This component generates a group of checkboxes.
clickButton
Link copied to clipboard
js
fun RenderContext.clickButton(styling: BasicParams.() -> Unit = {}, baseClass: StyleClass? = null, id: String? = null, prefix: String = "push-button", build: PushButtonComponent.() -> Unit = {}): Listener<MouseEvent, HTMLButtonElement>
This component generates a simple button.
createIconSvgElement
Link copied to clipboard
js
fun createIconSvgElement(baseClass: String?): SVGElement
flexBox
Link copied to clipboard
js
fun RenderContext.flexBox(styling: FlexParams.() -> Unit = {}, baseClass: StyleClass? = null, id: String? = null, prefix: String = "flex-box", init: Div.() -> Unit): Div
This component represents a layout component with flex property.
formControl
Link copied to clipboard
js
fun RenderContext.formControl(styling: BasicParams.() -> Unit = {}, baseClass: StyleClass? = null, id: String? = null, prefix: String = "formControl", build: FormControlComponent.() -> Unit = {})
This component wraps different kind of input elements like inputField, checkbox, checkboxGroup, radioGroup.
gridBox
Link copied to clipboard
js
fun RenderContext.gridBox(styling: GridParams.() -> Unit = {}, baseClass: StyleClass? = null, id: String? = null, prefix: String = "grid-box", init: Div.() -> Unit): Div
This component represents a layout component with grid property.
icon
Link copied to clipboard
js
fun RenderContext.icon(styling: BasicParams.() -> Unit = {}, baseClass: StyleClass? = null, id: String? = null, prefix: String = IconComponent.prefix, build: IconComponent.() -> Unit = {})
This component enables to render an icon.
inputField
Link copied to clipboard
js
fun RenderContext.inputField(styling: BasicParams.() -> Unit = {}, store: Store<String>? = null, baseClass: StyleClass? = null, id: String? = null, prefix: String = "inputField", build: InputFieldComponent.() -> Unit = {})
This component generates a text based input field.
lineUp
Link copied to clipboard
js
fun RenderContext.lineUp(styling: FlexParams.() -> Unit = {}, baseClass: StyleClass? = null, id: String? = null, prefix: String = "line-up", build: LineUpComponent.() -> Unit = {}): Div
This layout component enables the horizontal stacking of child components.
modal
Link copied to clipboard
js
fun modal(styling: BasicParams.() -> Unit = {}, baseClass: StyleClass? = null, id: String? = null, prefix: String = "modal", build: ModalComponent.(SimpleHandler<Unit>) -> Unit): SimpleHandler<Unit>
This component provides some modal dialog or messagebox.
navBar
Link copied to clipboard
js
fun RenderContext.navBar(styling: BasicParams.() -> Unit = {}, store: Store<String>? = null, baseClass: StyleClass? = null, id: String? = null, prefix: String = "navBar", build: NavbarComponent.() -> Unit = {})
popover
Link copied to clipboard
js
fun RenderContext.popover(styling: BasicParams.() -> Unit = {}, baseClass: StyleClass? = null, id: String? = null, prefix: String = "popover", build: PopoverComponent.() -> Unit = {})
This component enables to render a popover thats floats around a trigger.
pushButton
Link copied to clipboard
js
fun RenderContext.pushButton(styling: BasicParams.() -> Unit = {}, baseClass: StyleClass? = null, id: String? = null, prefix: String = "push-button", build: PushButtonComponent.() -> Unit = {})
This component generates a simple button.
radio
Link copied to clipboard
js
fun RenderContext.radio(styling: BasicParams.() -> Unit = {}, baseClass: StyleClass? = null, id: String? = null, prefix: String = "radioComponent", build: RadioComponent.() -> Unit = {}): Label
This component generates a single checkbox.
radioGroup
Link copied to clipboard
js
fun <T> RenderContext.radioGroup(styling: BasicParams.() -> Unit = {}, store: Store<T>, baseClass: StyleClass? = null, id: String? = null, prefix: String = "radioGroupComponent", build: RadioGroupComponent<T>.() -> Unit = {})
This component generates a group of radio buttons.
spinner
Link copied to clipboard
js
fun RenderContext.spinner(styling: BasicParams.() -> Unit = {}, baseClass: StyleClass? = null, id: String? = null, prefix: String = "spinner", build: SpinnerComponent.() -> Unit)
This component generates an animated spinner.
stackUp
Link copied to clipboard
js
fun RenderContext.stackUp(styling: FlexParams.() -> Unit = {}, baseClass: StyleClass? = null, id: String? = null, prefix: String = "stack-up", build: StackUpComponent.() -> Unit = {}): Div
This layout component enables the vertical stacking of child components.
svg
Link copied to clipboard
js
fun RenderContext.svg(baseClass: String?, id: String?, init: Svg.() -> Unit): Svg
switch
Link copied to clipboard
js
fun RenderContext.switch(styling: BasicParams.() -> Unit = {}, store: Store<Boolean>, baseClass: StyleClass? = null, prefix: String = "switchComponent", build: SwitchComponent.() -> Unit = {})
fun RenderContext.switch(styling: BasicParams.() -> Unit = {}, baseClass: StyleClass? = null, id: String? = null, prefix: String = "switchComponent", build: SwitchComponent.() -> Unit = {}): Label
This component generates a single switch.
textArea
Link copied to clipboard
js
fun RenderContext.textArea(styling: BasicParams.() -> Unit = {}, store: Store<String>? = null, baseClass: StyleClass? = null, id: String? = null, prefix: String = "textArea", init: TextAreaComponent.() -> Unit)
This component generates a textareaYou can optionally pass in a store in order to set the value and react to updates automatically.
tooltip
Link copied to clipboard
js
fun StyleParams.tooltip(vararg text: String): BasicParams.() -> Unit
fun StyleParams.tooltip(vararg text: String, tooltipPlacement: TooltipPlacements.() -> Style<BasicParams>): BasicParams.() -> Unit

Properties

xmlns
Link copied to clipboard
js
const val xmlns: String