blob: 664730346892c345f736dc376cd9de484cf42856 [file] [log] [blame]
/*
* Copyright 2019 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.ui.foundation
import androidx.ui.semantics.Semantics
import androidx.ui.core.gesture.PressReleasedGestureDetector
import androidx.compose.composer
import androidx.compose.Composable
import androidx.ui.semantics.enabled
import androidx.ui.semantics.onClick
/**
* Combines [PressReleasedGestureDetector] and [Semantics] for the clickable
* components like Button.
*
* @sample androidx.ui.foundation.samples.ClickableSample
*
* @param onClick will be called when user clicked on the button. The button will not be
* clickable when it is null.
* @param consumeDownOnStart true means [PressReleasedGestureDetector] should consume
* down events. Provide false if you have some visual feedback like Ripples,
* as it will consume this events instead.
*/
@Composable
fun Clickable(
onClick: (() -> Unit)? = null,
consumeDownOnStart: Boolean = false,
children: @Composable() () -> Unit
) {
Semantics(
properties = {
enabled = (onClick != null)
if (onClick != null) {
onClick(action = onClick)
}
}
) {
PressReleasedGestureDetector(
onRelease = onClick,
consumeDownOnStart = consumeDownOnStart
) {
children()
}
}
}