ProgressSemantics.kt
/*
* 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.compose.foundation
import androidx.compose.runtime.Stable
import androidx.compose.ui.Modifier
import androidx.compose.ui.semantics.AccessibilityRangeInfo
import androidx.compose.ui.semantics.accessibilityValue
import androidx.compose.ui.semantics.accessibilityValueRange
import androidx.compose.ui.semantics.semantics
import androidx.compose.ui.util.annotation.FloatRange
import androidx.compose.ui.util.format
import kotlin.math.roundToInt
/**
* Contains the [semantics] required for a determinate progress indicator, that represents progress
* ranging from 0.0 to 1.0. Values for [progress] outside of this range will be coerced into this
* range.
*
* @sample androidx.compose.foundation.samples.DeterminateProgressSemanticsSample
*
* @param progress The progress of this progress indicator, where 0.0 represents no progress and 1.0
* represents full progress. If the value is outside of this range, it will be coerced into the
* range.
*/
@Stable
fun Modifier.progressSemantics(
@FloatRange(from = 0.0, to = 1.0) progress: Float
): Modifier {
@Suppress("NAME_SHADOWING")
val progress = progress.coerceIn(0f, 1f)
// We only display 0% or 100% when it is exactly 0% or 100%.
val percent = when (progress) {
0f -> 0
1f -> 100
else -> (progress * 100).roundToInt().coerceIn(1, 99)
}
return semantics {
accessibilityValue = Strings.TemplatePercent.format(percent)
accessibilityValueRange = AccessibilityRangeInfo(progress, 0f..1f)
}
}
/**
* Contains the [semantics] required for an indeterminate progress indicator, that represents the
* fact of the in-progress operation.
*
* If you need determinate progress 0.0 to 1.0, consider using overload with the progress
* parameter.
*
* @sample androidx.compose.foundation.samples.IndeterminateProgressSemanticsSample
*
*/
@Stable
fun Modifier.progressSemantics(): Modifier {
return semantics { accessibilityValue = Strings.InProgress }
}