FocusRequesterModifier.kt
/*
* Copyright 2020 The Android Open Source Project
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package androidx.compose.ui.focus
import androidx.compose.ui.Modifier
import androidx.compose.ui.platform.InspectorInfo
import androidx.compose.ui.platform.InspectorValueInfo
import androidx.compose.ui.platform.debugInspectorInfo
/**
* A [modifier][Modifier.Element] that is used to pass in a [FocusRequester] that can be used to
* request focus state changes.
*
* @sample androidx.compose.ui.samples.RequestFocusSample
*
* @see FocusRequester
* @see Modifier.focusRequester
*/
interface FocusRequesterModifier : Modifier.Element {
/**
* An instance of [FocusRequester], that can be used to request focus state changes.
*
* @sample androidx.compose.ui.samples.RequestFocusSample
*/
val focusRequester: FocusRequester
}
internal class FocusRequesterModifierImpl(
override val focusRequester: FocusRequester,
inspectorInfo: InspectorInfo.() -> Unit
) : FocusRequesterModifier, InspectorValueInfo(inspectorInfo)
/**
* Add this modifier to a component to request changes to focus.
*
* @sample androidx.compose.ui.samples.RequestFocusSample
*/
fun Modifier.focusRequester(focusRequester: FocusRequester): Modifier {
return this.then(
FocusRequesterModifierImpl(
focusRequester = focusRequester,
inspectorInfo = debugInspectorInfo {
name = "focusRequester"
properties["focusRequester"] = focusRequester
}
)
)
}