components/dev.fritz2.components/TextAreaComponent

TextAreaComponent

open class TextAreaComponent(valueStore: Store<String>?) : Component<Unit> , EventProperties<HTMLTextAreaElement> , ElementProperties<TextArea> , InputFormProperties, SeverityProperties

This class handles the configuration of an textarea element

The 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 !

Constructors

TextAreaComponent

fun TextAreaComponent(valueStore: Store<String>? = null)

Types

Companion

object Companion

Functions

enabled

open override fun enabled(value: Boolean)

open override fun enabled(value: Flow<Boolean>)

equals

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

hashCode

open fun hashCode(): Int

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.

severity

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

Property to manage the severity value of the component.

severityClassOf

open override 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

disabled

open override val disabled: DynamicComponentProperty<Boolean>

element

open override val element: ComponentProperty<TextArea.() -> Unit>

This property enables the client to access the deeper features of an element even though the component itself does not offer an appropriate functionality.

events

open override val events: ComponentProperty<EventContext<HTMLTextAreaElement>.() -> Unit>

This property enables the client to access all events offered by the underlying HTML element.

placeholder

val placeholder: DynamicComponentProperty<String>

readonly

open override val readonly: DynamicComponentProperty<Boolean>

resizeBehavior

val resizeBehavior: ComponentProperty<TextAreaResize.() -> Style<BasicParams>>

severity

open override val severity: NullableDynamicComponentProperty<Severity?>

size

val size: ComponentProperty<FormSizes.() -> Style<BasicParams>>

value

val value: DynamicComponentProperty<String>

variant

val variant: ComponentProperty<TextAreaVariants.() -> Style<BasicParams>>