components/dev.fritz2.components/SeverityProperties

SeverityProperties

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

The property severity is offered in order to hold the current severity value.

In order to reactively apply an appropriate styling based upon the current severity value of the component - changing the background color for example - the helper function severityClassOf helps to choose the corresponding style bades upon the SeverityStyles interface from the dev.fritz2.styling.theme package.

Types

SeverityContext

class SeverityContext

Functions

equals

open operator fun equals(other: Any?): Boolean

hashCode

open fun hashCode(): Int

severity

open fun severity(value: SeverityProperties.SeverityContext.() -> Severity)

Property to manage the severity value of the component.

severityClassOf

open fun severityClassOf(severityStyle: SeverityStyles): Flow<StyleClass>

This function manages the task to map a value of the Severity enumeration to a corresponding style defined within the SeverityStyles interface.

toString

open fun toString(): String

Properties

severity

abstract val severity: NullableDynamicComponentProperty<Severity?>

Inheritors

CheckboxComponent

CheckboxGroupComponent

SeverityMixin

InputFieldComponent

RadioComponent

RadioGroupComponent

SwitchComponent

TextAreaComponent

SelectFieldComponent