-
Notifications
You must be signed in to change notification settings - Fork 98
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Support for Steppers with RSB built in (#1749)
- Loading branch information
Showing
10 changed files
with
335 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
178 changes: 178 additions & 0 deletions
178
compose-material/src/main/java/com/google/android/horologist/compose/material/Stepper.kt
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,178 @@ | ||
| /* | ||
| * Copyright 2023 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 | ||
| * | ||
| * https://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 com.google.android.horologist.compose.material | ||
|
|
||
| import androidx.compose.foundation.layout.BoxScope | ||
| import androidx.compose.runtime.Composable | ||
| import androidx.compose.runtime.remember | ||
| import androidx.compose.ui.Modifier | ||
| import androidx.compose.ui.graphics.Color | ||
| import androidx.compose.ui.res.stringResource | ||
| import androidx.compose.ui.util.lerp | ||
| import androidx.wear.compose.material.MaterialTheme | ||
| import androidx.wear.compose.material.StepperDefaults | ||
| import androidx.wear.compose.material.contentColorFor | ||
| import com.google.android.horologist.compose.rotaryinput.RotaryDefaults | ||
| import com.google.android.horologist.compose.rotaryinput.onRotaryInputAccumulatedWithFocus | ||
| import kotlin.math.roundToInt | ||
|
|
||
| /** | ||
| * Wrapper for androidx.wear.compose.material.Stepper with default RSB scroll support. | ||
| * | ||
| * @see androidx.wear.compose.material.Stepper | ||
| */ | ||
| @Composable | ||
| public fun Stepper( | ||
| value: Float, | ||
| onValueChange: (Float) -> Unit, | ||
| steps: Int, | ||
| modifier: Modifier = Modifier, | ||
| decreaseIcon: @Composable () -> Unit = { | ||
| Icon( | ||
| StepperDefaults.Decrease, | ||
| stringResource(R.string.horologist_stepper_decrease_content_description), | ||
| ) | ||
| }, | ||
| increaseIcon: @Composable () -> Unit = { | ||
| Icon( | ||
| StepperDefaults.Increase, | ||
| stringResource(R.string.horologist_stepper_increase_content_description), | ||
| ) | ||
| }, | ||
| valueRange: ClosedFloatingPointRange<Float> = 0f..(steps + 1).toFloat(), | ||
| backgroundColor: Color = MaterialTheme.colors.background, | ||
| contentColor: Color = contentColorFor(backgroundColor), | ||
| iconColor: Color = contentColor, | ||
| enableRangeSemantics: Boolean = true, | ||
| content: @Composable BoxScope.() -> Unit, | ||
| ) { | ||
| val isLowRes = RotaryDefaults.isLowResInput() | ||
|
|
||
| val currentStep = remember(value, valueRange, steps) { | ||
| snapValueToStep( | ||
| value, | ||
| valueRange, | ||
| steps, | ||
| ) | ||
| } | ||
|
|
||
| val updateValue: (Int) -> Unit = { stepDiff -> | ||
| val newValue = calculateCurrentStepValue(currentStep + stepDiff, steps, valueRange) | ||
| if (newValue != value) onValueChange(newValue) | ||
| } | ||
|
|
||
| androidx.wear.compose.material.Stepper( | ||
| value, | ||
| onValueChange, | ||
| steps, | ||
| decreaseIcon, | ||
| increaseIcon, | ||
| modifier.onRotaryInputAccumulatedWithFocus(isLowRes = isLowRes, onValueChange = { | ||
| if (it < 0f) { | ||
| updateValue(1) | ||
| } else if (it > 0f) { | ||
| updateValue(-1) | ||
| } | ||
| }), | ||
| valueRange, | ||
| backgroundColor, | ||
| contentColor, | ||
| iconColor, | ||
| enableRangeSemantics, | ||
| content, | ||
| ) | ||
| } | ||
|
|
||
| /** | ||
| * Wrapper for androidx.wear.compose.material.Stepper with default RSB scroll support. | ||
| * | ||
| * @see androidx.wear.compose.material.Stepper | ||
| */ | ||
| @Composable | ||
| public fun Stepper( | ||
| value: Int, | ||
| onValueChange: (Int) -> Unit, | ||
| valueProgression: IntProgression, | ||
| modifier: Modifier = Modifier, | ||
| decreaseIcon: @Composable () -> Unit = { | ||
| Icon( | ||
| StepperDefaults.Decrease, | ||
| stringResource(R.string.horologist_stepper_decrease_content_description), | ||
| ) | ||
| }, | ||
| increaseIcon: @Composable () -> Unit = { | ||
| Icon( | ||
| StepperDefaults.Increase, | ||
| stringResource(R.string.horologist_stepper_increase_content_description), | ||
| ) | ||
| }, | ||
| backgroundColor: Color = MaterialTheme.colors.background, | ||
| contentColor: Color = contentColorFor(backgroundColor), | ||
| iconColor: Color = contentColor, | ||
| enableRangeSemantics: Boolean = true, | ||
| content: @Composable BoxScope.() -> Unit, | ||
| ) { | ||
| val isLowRes = RotaryDefaults.isLowResInput() | ||
| androidx.wear.compose.material.Stepper( | ||
| value, | ||
| onValueChange, | ||
| valueProgression, | ||
| decreaseIcon, | ||
| increaseIcon, | ||
| modifier.onRotaryInputAccumulatedWithFocus(isLowRes = isLowRes, onValueChange = { | ||
| if (it < 0f) { | ||
| val newValue = (value + valueProgression.step) | ||
| if (newValue <= valueProgression.last) { | ||
| onValueChange(newValue) | ||
| } | ||
| } else if (it > 0f) { | ||
| val newValue = (value - valueProgression.step) | ||
| if (newValue >= valueProgression.first) { | ||
| onValueChange(newValue) | ||
| } | ||
| } | ||
| }), | ||
| backgroundColor, | ||
| contentColor, | ||
| iconColor, | ||
| enableRangeSemantics, | ||
| content, | ||
| ) | ||
| } | ||
|
|
||
| /** | ||
| * Calculates value of [currentStep] in [valueRange] depending on number of [steps] | ||
| */ | ||
| internal fun calculateCurrentStepValue( | ||
| currentStep: Int, | ||
| steps: Int, | ||
| valueRange: ClosedFloatingPointRange<Float>, | ||
| ): Float = lerp( | ||
| valueRange.start, | ||
| valueRange.endInclusive, | ||
| currentStep.toFloat() / (steps + 1).toFloat(), | ||
| ).coerceIn(valueRange) | ||
|
|
||
| /** | ||
| * Snaps [value] to the closest [step] in the [valueRange] | ||
| */ | ||
| internal fun snapValueToStep( | ||
| value: Float, | ||
| valueRange: ClosedFloatingPointRange<Float>, | ||
| steps: Int, | ||
| ): Int = ((value - valueRange.start) / (valueRange.endInclusive - valueRange.start) * (steps + 1)).roundToInt() | ||
| .coerceIn(0, steps + 1) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
70 changes: 70 additions & 0 deletions
70
...-material/src/test/java/com/google/android/horologist/compose/material/StepperA11yTest.kt
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,70 @@ | ||
| /* | ||
| * Copyright 2023 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 | ||
| * | ||
| * https://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 com.google.android.horologist.compose.material | ||
|
|
||
| import androidx.compose.runtime.getValue | ||
| import androidx.compose.runtime.mutableFloatStateOf | ||
| import androidx.compose.runtime.mutableIntStateOf | ||
| import androidx.compose.runtime.remember | ||
| import androidx.compose.runtime.setValue | ||
| import androidx.wear.compose.material.Text | ||
| import com.google.android.horologist.screenshots.ScreenshotBaseTest | ||
| import com.google.android.horologist.screenshots.ScreenshotTestRule | ||
| import org.junit.Test | ||
|
|
||
| class StepperA11yTest : | ||
| ScreenshotBaseTest( | ||
| ScreenshotTestRule.screenshotTestRuleParams { | ||
| enableA11y = true | ||
| screenTimeText = {} | ||
| record = ScreenshotTestRule.RecordMode.Repair | ||
| }, | ||
| ) { | ||
|
|
||
| @Test | ||
| fun float() { | ||
| screenshotTestRule.setContent(takeScreenshot = true) { | ||
| var value by remember { | ||
| mutableFloatStateOf(0f) | ||
| } | ||
| Stepper( | ||
| value = value, | ||
| onValueChange = { value = it }, | ||
| valueRange = 0f..100f, | ||
| steps = 9, | ||
| ) { | ||
| Text("Value: $value") | ||
| } | ||
| } | ||
| } | ||
|
|
||
| @Test | ||
| fun int() { | ||
| screenshotTestRule.setContent(takeScreenshot = true) { | ||
| var value by remember { | ||
| mutableIntStateOf(0) | ||
| } | ||
| Stepper( | ||
| value = value, | ||
| onValueChange = { value = it }, | ||
| valueProgression = IntProgression.fromClosedRange(0, 100, 10), | ||
| ) { | ||
| Text("Value: $value") | ||
| } | ||
| } | ||
| } | ||
| } |
67 changes: 67 additions & 0 deletions
67
compose-material/src/test/java/com/google/android/horologist/compose/material/StepperTest.kt
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,67 @@ | ||
| /* | ||
| * Copyright 2023 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 | ||
| * | ||
| * https://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 com.google.android.horologist.compose.material | ||
|
|
||
| import androidx.compose.runtime.getValue | ||
| import androidx.compose.runtime.mutableFloatStateOf | ||
| import androidx.compose.runtime.mutableIntStateOf | ||
| import androidx.compose.runtime.remember | ||
| import androidx.compose.runtime.setValue | ||
| import androidx.wear.compose.material.Text | ||
| import com.google.android.horologist.screenshots.ScreenshotBaseTest | ||
| import com.google.android.horologist.screenshots.ScreenshotTestRule | ||
| import org.junit.Test | ||
|
|
||
| class StepperTest : ScreenshotBaseTest( | ||
| params = ScreenshotTestRule.screenshotTestRuleParams { | ||
| screenTimeText = {} | ||
| }, | ||
| ) { | ||
|
|
||
| @Test | ||
| fun float() { | ||
| screenshotTestRule.setContent(takeScreenshot = true, roundScreen = true) { | ||
| var value by remember { | ||
| mutableFloatStateOf(0f) | ||
| } | ||
| Stepper( | ||
| value = value, | ||
| onValueChange = { value = it }, | ||
| valueRange = 0f..100f, | ||
| steps = 9, | ||
| ) { | ||
| Text("Value: $value") | ||
| } | ||
| } | ||
| } | ||
|
|
||
| @Test | ||
| fun int() { | ||
| screenshotTestRule.setContent(takeScreenshot = true, roundScreen = true) { | ||
| var value by remember { | ||
| mutableIntStateOf(0) | ||
| } | ||
| Stepper( | ||
| value = value, | ||
| onValueChange = { value = it }, | ||
| valueProgression = IntProgression.fromClosedRange(0, 100, 10), | ||
| ) { | ||
| Text("Value: $value") | ||
| } | ||
| } | ||
| } | ||
| } |
3 changes: 3 additions & 0 deletions
3
...images/com.google.android.horologist.compose.material_StepperA11yTest_float.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
3 changes: 3 additions & 0 deletions
3
...s/images/com.google.android.horologist.compose.material_StepperA11yTest_int.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
3 changes: 3 additions & 0 deletions
3
...ots/images/com.google.android.horologist.compose.material_StepperTest_float.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
3 changes: 3 additions & 0 deletions
3
...shots/images/com.google.android.horologist.compose.material_StepperTest_int.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.