You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
* Password input is a UI element that allows to securely and confidentially capture a user's password.
149
+
* Password Input enhances privacy by replacing characters with dots, while they are being typed; and also embeds usability features such as the ability
150
+
* to show and hide password, and helper text to guide password creation.
151
+
*
152
+
* Rounded corners can be enabled or disabled using [OudsThemeSettings.roundedCornerTextInputs] property in the settings of the theme provided when calling
153
+
* the [com.orange.ouds.core.theme.OudsTheme] method.
* @param state The editable text state of the password input, including the text itself, position of the cursor or selection and the text obfuscation mode.
160
+
* @param modifier [Modifier] applied to the password input.
161
+
* @param label Label displayed above the password input. It describes the purpose of the input.
162
+
* @param placeholder Text displayed when the password input is empty. It provides a hint or guidance inside the field to suggest expected input.
163
+
* @param lockIcon When `true`, a lock icon is displayed at the start of the password input to visually reinforce the security context. Defaults to `false`.
164
+
* @param prefix Text placed before the user's input. A prefix is not common and is discouraged in a Password Input component. In very specific cases,
165
+
* it can provide context or format requirements (e.g., “DEV-” for test accounts, "admin-" as a pattern to define an admin password)
166
+
* @param enabled Controls the enabled state of the password input. When `false`, this password input will not be focusable and will not react to input events.
167
+
* True by default.
168
+
* @param readOnly Controls the read-only state of the password input. When `true`, the text is visible but not editable.
169
+
* False by default.
170
+
* @param loader An optional loading progress indicator displayed in the password input to indicate an ongoing operation.
171
+
* @param outlined Controls the style of the password input. When `true`, it displays a minimalist password input with a transparent background and a visible
172
+
* stroke outlining the field.
173
+
* @param error Optional [OudsError] to indicate that the user input does not meet validation rules or expected formatting. Pass `null` if there is no error.
174
+
* @param helperText An annotated helper text displayed below the password input. It conveys additional information about the input field, such as how it will be
175
+
* used. It should ideally only take up a single line, though it may wrap to multiple lines if required.
176
+
* @param constrainedMaxWidth When `true`, the password input width is constrained to a maximum value defined by the design system.
177
+
* When `false`, no specific width constraint is applied, allowing the component to size itself or follow external modifiers.
178
+
* Defaults to `false`.
179
+
* @param inputTransformation An optional [InputTransformation] that will be used to transform changes to the [OudsPasswordInputState] made by the user. The transformation
180
+
* will be applied to changes made by hardware and software keyboard events, pasting or dropping text, accessibility services, and tests. The transformation
181
+
* will _not_ be applied when changing the [state] programmatically, or when the transformation is changed. If the transformation is changed on an
182
+
* existing text field, it will be applied to the next user edit. The transformation will not immediately affect the current [state].
183
+
* @param keyboardOptions Software keyboard options that contain configurations such as [KeyboardType] and [ImeAction].
184
+
* @param onKeyboardAction Called when the user presses the action button in the input method editor (IME), or by pressing the enter key on a hardware keyboard.
185
+
* By default this parameter is null, and would execute the default behavior for a received IME Action e.g., [ImeAction.Done] would close the keyboard,
186
+
* [ImeAction.Next] would switch the focus to the next focusable item on the screen.
187
+
* @param onTextLayout Callback that is executed when a new text layout is calculated. A [TextLayoutResult] object that callback provides contains paragraph
188
+
* information, size of the text, baselines and other details. The callback can be used to add additional decoration or functionality to the text.
189
+
* For example, to draw a cursor or selection around the text.
190
+
* @param interactionSource An optional hoisted [MutableInteractionSource] for observing and emitting [Interaction]s for this password input. Note that if `null`
191
+
* is provided, interactions will still happen internally.
* PIN code input is a UI element that allows to capture short, fixed-length numeric codes, typically for authentication or confirmation purposes, such as a
144
+
* four, six or eight-digit personal identification number (PIN). PIN code input is presented as a series of individual input fields or boxes, each
145
+
* representing a single digit, to enhance readability and encourage accurate input, while supporting smooth keyboard navigation and secured input masking if
146
+
* needed.
147
+
*
148
+
* Rounded corners can be enabled or disabled using [OudsThemeSettings.roundedCornerTextInputs] property in the settings of the theme provided when calling
149
+
* the [com.orange.ouds.core.theme.OudsTheme] method.
* @param value The current PIN code value as a string of digits. The value is automatically truncated to the specified [length].
156
+
* @param onValueChange Callback invoked when the PIN code value changes. The updated PIN code value comes as a parameter of the callback.
157
+
* @param modifier [Modifier] applied to the PIN code input.
158
+
* @param length The number of digits in the PIN code. Defaults to [OudsPinCodeInputDefaults.Length].
159
+
* @param outlined Controls the style of the PIN code input. When `true`, it displays a minimalist PIN code input with a transparent background and a visible
160
+
* stroke outlining each digit box.
161
+
* @param error Optional [OudsError] to indicate that the user input does not meet validation rules or expected formatting. Pass `null` if there is no error.
162
+
* @param helperText An annotated helper text displayed below the PIN code input. It conveys additional information about the input field, such as how it will be
163
+
* used. It should ideally only take up a single line, though it may wrap to multiple lines if required.
164
+
* @param onKeyboardAction Called when the user presses the action button in the input method editor (IME), or by pressing the enter key on a hardware keyboard.
165
+
* By default, this parameter is null, and would execute the default behavior for a received IME Action e.g., [androidx.compose.ui.text.input.ImeAction.Done] would close the keyboard,
166
+
* [androidx.compose.ui.text.input.ImeAction.Next] would switch the focus to the next focusable item on the screen.
167
+
* @param interactionSource An optional hoisted [MutableInteractionSource] for observing and emitting [Interaction]s for this PIN code input. Note that if `null`
168
+
* is provided, interactions will still happen internally.
0 commit comments