Package dev.fritz2.components.foundations

Types

CloseButtonMixin

class CloseButtonMixin(closeButtonPrefix: String, defaultStyle: Style<BasicParams>) : CloseButtonProperty

Default implementation of the CloseButtonProperty interface in order to apply this as mixin for a component

CloseButtonProperty

interface CloseButtonProperty

This interface offers some convenience properties for adding a close button to a component.

Component

interface Component<T>

Marker interface that every component should implement, so that the central render method appears in a unified way throughout this framework.

ComponentProperty

class ComponentProperty<T>(value: T)

Generic container for modeling a property for a component class.

DynamicComponentProperty

class DynamicComponentProperty<T>(values: Flow<T>)

Generic container for modeling a property for a component class that could be either consist on a value or on a Flow of a value.

ElementMixin

class ElementMixin<T> : ElementProperties<T>

Default implementation of the ElementProperties interface in order to apply this as mixin for a component

ElementProperties

interface ElementProperties<T>

An interface for exposing an HTML element.

EventMixin

class EventMixin<T : Element> : EventProperties<T>

Default implementation of the EventProperties interface in order to apply this as mixin for a component

EventProperties

interface EventProperties<T : Element>

An interface for exposing the events of a component.

FormMixin

open class FormMixin : FormProperties

Default implementation of the FormProperties interface in order to apply this as mixin for a component

FormProperties

interface FormProperties

This interface add typical state properties for en- or disabling form components.

InputFieldMixin

class InputFieldMixin : InputFieldProperties

Default implementation of the InputFieldProperties interface in order to apply this as mixin for a component

InputFieldProperties

interface InputFieldProperties

This interface offers a convenience property for inputField based components.

InputFormMixin

class InputFormMixin : FormMixin, InputFormProperties

Default implementation of the InputFormProperties interface in order to apply this as mixin for a component

InputFormProperties

interface InputFormProperties : FormProperties

This interface offers a convenience property for input form based components.

ManagedComponent

interface ManagedComponent<T>

This interface should be implemented by all components, that should appear at a specific, centralized node within the DOM tree.

MultiSelectionStore

open class MultiSelectionStore<T> : RootStore<List<T>>

This store can be used for components with an internal store that has to deal with a List of some type T.

NullableDynamicComponentProperty

class NullableDynamicComponentProperty<T>(values: Flow<T?>)

Generic container for modeling a property for a component class that could be either consist on a nullable value or on a Flow of a nullable value.

Orientation

enum Orientation : Enum<Orientation>

Definition of the layout orientation of a form.

OrientationContext

object OrientationContext

A context class for allowing an expressive DSL for component's configuration:

// 'orientation' is provided by ``OrientationProperty.orientation``
orientation { horizontal }
orientation { vertical }

OrientationMixin

class OrientationMixin(default: Orientation) : OrientationProperty

Default implementation of the OrientationProperty interface in order to apply this as mixin for a component

OrientationProperty

interface OrientationProperty

This interface add an orientation property for position the component's element(s) into an horizontal or vertical orientation.

SeverityMixin

class SeverityMixin : SeverityProperties

Default implementation of the SeverityProperties interface in order to apply this as mixin for a component

SeverityProperties

interface SeverityProperties

This interface defines convenience properties and helper functions to easily apply Severity based behaviour to a component.

SingleSelectionStore

open class SingleSelectionStore : RootStore<Int?>

This store can be used for components with an internal store that has to deal with a single element selection from a collection of predefined values (like for a selectField or radioGroup component)It is based upon the index of an item from the list represented by the Int type.

TooltipMixin

open class TooltipMixin : TooltipProperties

Default implementation of TooltipProperties interface in order to apply this as mixin for a component

TooltipProperties

interface TooltipProperties

This interface offers convenience functions to call a tooltip from withiin a component.

Functions

randomId

fun randomId(): String

Creates a random id based on random number and timestamp.