1 /*
2 * Copyright 2024 The Android Open Source Project
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16
17 package androidx.compose.foundation.text.input
18
19 import androidx.compose.runtime.Composable
20
21 /**
22 * Composable interface that allows to add decorations around text field, such as icon, placeholder,
23 * helper messages or similar, and automatically increase the hit target area of the text field.
24 *
25 * @sample androidx.compose.foundation.samples.BasicTextFieldDecoratorSample
26 */
interfacenull27 fun interface TextFieldDecorator {
28
29 /**
30 * To allow you to control the placement of the inner text field relative to your decorations,
31 * the text field implementation will pass in a framework-controlled composable parameter
32 * [innerTextField] to this method. You must not call [innerTextField] more than once.
33 */
34 // Composable parameters of Composable functions are normally slots for callers to inject
35 // their content but this one is a special inverted-slot API. It's better to be explicit
36 // with the naming.
37 @Suppress("ComposableLambdaParameterNaming")
38 @Composable
39 fun Decoration(innerTextField: @Composable () -> Unit)
40 }
41