InputFieldComponent

open class InputFieldComponent(valueStore: Store<String>?) : Component<Unit> , EventProperties<HTMLInputElement> , ElementProperties<Input> , InputFormProperties, SeverityProperties

This class deals with the configuration of an input element.

The inputField can be configured for the following aspects:

  • the size of the element

  • some predefined styling variants

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

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

Constructors

InputFieldComponent
Link copied to clipboard
js
fun InputFieldComponent(valueStore: Store<String>?)

Types

Companion
Link copied to clipboard
js
object Companion

Functions

enabled
Link copied to clipboard
js
open override fun enabled(value: Boolean)
open override fun enabled(value: Flow<Boolean>)
equals
Link copied to clipboard
js
open operator fun equals(other: Any?): Boolean
hashCode
Link copied to clipboard
js
open fun hashCode(): Int
render
Link copied to clipboard
js
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
Link copied to clipboard
js
open override fun severity(value: SeverityProperties.SeverityContext.() -> Severity)
Property to manage the severity value of the component.
severityClassOf
Link copied to clipboard
js
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
Link copied to clipboard
js
open fun toString(): String

Properties

disabled
Link copied to clipboard
js
open override val disabled: DynamicComponentProperty<Boolean>
element
Link copied to clipboard
js
open override val element: ComponentProperty<Input.() -> 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
Link copied to clipboard
js
open override val events: ComponentProperty<EventContext<HTMLInputElement>.() -> Unit>
This property enables the client to access all events offered by the underlying HTML element.
placeholder
Link copied to clipboard
js
val placeholder: DynamicComponentProperty<String>
readonly
Link copied to clipboard
js
open override val readonly: DynamicComponentProperty<Boolean>
severity
Link copied to clipboard
js
open override val severity: NullableDynamicComponentProperty<Severity?>
size
Link copied to clipboard
js
val size: ComponentProperty<FormSizes.() -> Style<BasicParams>>
step
Link copied to clipboard
js
val step: DynamicComponentProperty<String>
type
Link copied to clipboard
js
val type: DynamicComponentProperty<String>
value
Link copied to clipboard
js
val value: DynamicComponentProperty<String>
variant
Link copied to clipboard
js
val variant: ComponentProperty<InputFieldVariants.() -> Style<BasicParams>>