InputTransformation.Companion

Summary

Public functions
open Unit

The transform operation.
Cmn

Inherited functions
From androidx.compose.foundation.text.input.InputTransformation
open Unit

Optional semantics configuration that can update certain characteristics of the applied TextField, e.g. SemanticsPropertyReceiver.maxTextLength.
Cmn

Inherited properties
From androidx.compose.foundation.text.input.InputTransformation
open KeyboardOptions?

Optional KeyboardOptions that will be used as the default keyboard options for configuring the IME.
Cmn

Public functions

transformInput

Cmn 
open fun TextFieldBuffer.transformInput(): Unit

The transform operation. For more information see the documentation on InputTransformation.

This function is scoped to TextFieldBuffer, a buffer that can be changed in-place to alter or reject the changes or set the selection.

To reject all changes in the scoped TextFieldBuffer, call revertAllChanges.

When multiple InputTransformations are linked together, the transformInput function of the first transformation is invoked before the second one. Once the changes are made to TextFieldBuffer by the initial InputTransformation in the chain, the same instance of TextFieldBuffer is forwarded to the subsequent transformation in the chain. Note that TextFieldBuffer.originalValue never changes while the buffer is passed along the chain. This sequence persists until the chain reaches its conclusion.