Merge "Add the checkbox preference" into main (ca1524c9) · Commits · e / os / android_frameworks_base

packages/SettingsLib/Spa/spa/src/com/android/settingslib/spa/widget/preference/CheckboxPreference.kt

0 → 100644

+181 −0

Original line number	Diff line number	Diff line
		/*
		* Copyright (C) 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
		*
		* 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 com.android.settingslib.spa.widget.preference

		import androidx.compose.foundation.LocalIndication
		import androidx.compose.foundation.interaction.MutableInteractionSource
		import androidx.compose.foundation.layout.Column
		import androidx.compose.foundation.layout.Spacer
		import androidx.compose.foundation.layout.width
		import androidx.compose.foundation.selection.toggleable
		import androidx.compose.material.icons.Icons
		import androidx.compose.material.icons.outlined.AirplanemodeActive
		import androidx.compose.runtime.Composable
		import androidx.compose.runtime.remember
		import androidx.compose.ui.Modifier
		import androidx.compose.ui.semantics.Role
		import androidx.compose.ui.tooling.preview.Preview
		import androidx.compose.ui.unit.Dp
		import com.android.settingslib.spa.framework.theme.SettingsDimension
		import com.android.settingslib.spa.framework.theme.SettingsTheme
		import com.android.settingslib.spa.framework.util.EntryHighlight
		import com.android.settingslib.spa.framework.util.wrapOnSwitchWithLog
		import com.android.settingslib.spa.widget.ui.SettingsCheckbox
		import com.android.settingslib.spa.widget.ui.SettingsIcon

		/**
		* The widget model for [CheckboxPreference] widget.
		*/
		interface CheckboxPreferenceModel {
		/**
		* The title of this [CheckboxPreference].
		*/
		val title: String

		/**
		* The summary of this [CheckboxPreference].
		*/
		val summary: () -> String
		get() = { "" }

		/**
		* The icon of this [Preference].
		*
		* Default is `null` which means no icon.
		*/
		val icon: (@Composable () -> Unit)?
		get() = null

		/**
		* Indicates whether this [CheckboxPreference] is checked.
		*
		* This can be `null` during the data loading before the data is available.
		*/
		val checked: () -> Boolean?

		/**
		* Indicates whether this [CheckboxPreference] is changeable.
		*
		* Not changeable [CheckboxPreference] will be displayed in disabled style.
		*/
		val changeable: () -> Boolean
		get() = { true }

		/**
		* The checkbox change handler of this [CheckboxPreference].
		*
		* If `null`, this [CheckboxPreference] is not [toggleable].
		*/
		val onCheckedChange: ((newChecked: Boolean) -> Unit)?
		}

		/**
		* CheckboxPreference widget.
		*
		* Data is provided through [CheckboxPreferenceModel].
		*/
		@Composable
		fun CheckboxPreference(model: CheckboxPreferenceModel) {
		EntryHighlight {
		InternalCheckboxPreference(
		title = model.title,
		summary = model.summary,
		icon = model.icon,
		checked = model.checked(),
		changeable = model.changeable(),
		onCheckedChange = model.onCheckedChange,
		)
		}
		}

		@Composable
		internal fun InternalCheckboxPreference(
		title: String,
		summary: () -> String = { "" },
		icon: @Composable (() -> Unit)? = null,
		checked: Boolean?,
		changeable: Boolean = true,
		paddingStart: Dp = SettingsDimension.itemPaddingStart,
		paddingEnd: Dp = SettingsDimension.itemPaddingEnd,
		paddingVertical: Dp = SettingsDimension.itemPaddingVertical,
		onCheckedChange: ((newChecked: Boolean) -> Unit)?,
		) {
		val indication = LocalIndication.current
		val onChangeWithLog = wrapOnSwitchWithLog(onCheckedChange)
		val interactionSource = remember { MutableInteractionSource() }
		val modifier = remember(checked, changeable) {
		if (checked != null && onChangeWithLog != null) {
		Modifier.toggleable(
		value = checked,
		interactionSource = interactionSource,
		indication = indication,
		enabled = changeable,
		role = Role.Checkbox,
		onValueChange = onChangeWithLog,
		)
		} else Modifier
		}
		BasePreference(
		title = title,
		summary = summary,
		modifier = modifier,
		enabled = { changeable },
		paddingStart = paddingStart,
		paddingEnd = paddingEnd,
		paddingVertical = paddingVertical,
		icon = icon,
		) {
		Spacer(Modifier.width(SettingsDimension.itemPaddingEnd))
		SettingsCheckbox(
		checked = checked,
		changeable = { changeable },
		// The onCheckedChange is handled on the whole CheckboxPreference.
		// DO NOT set it on SettingsCheckbox.
		onCheckedChange = null,
		interactionSource = interactionSource,
		)
		}
		}

		@Preview
		@Composable
		private fun CheckboxPreferencePreview() {
		SettingsTheme {
		Column {
		InternalCheckboxPreference(
		title = "Use Dark theme",
		checked = true,
		onCheckedChange = {},
		)
		InternalCheckboxPreference(
		title = "Use Dark theme",
		summary = { "Summary" },
		checked = false,
		onCheckedChange = {},
		)
		InternalCheckboxPreference(
		title = "Use Dark theme",
		summary = { "Summary" },
		checked = true,
		onCheckedChange = {},
		icon = @Composable {
		SettingsIcon(imageVector = Icons.Outlined.AirplanemodeActive)
		},
		)
		}
		}
		}

packages/SettingsLib/Spa/spa/src/com/android/settingslib/spa/widget/ui/Checkbox.kt

0 → 100644

+47 −0

Original line number	Diff line number	Diff line
		/*
		* Copyright (C) 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
		*
		* 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 com.android.settingslib.spa.widget.ui

		import androidx.compose.foundation.interaction.MutableInteractionSource
		import androidx.compose.material3.Checkbox
		import androidx.compose.runtime.Composable
		import androidx.compose.runtime.remember
		import com.android.settingslib.spa.framework.util.wrapOnSwitchWithLog

		@Composable
		internal fun SettingsCheckbox(
		checked: Boolean?,
		changeable: () -> Boolean,
		onCheckedChange: ((newChecked: Boolean) -> Unit)? = null,
		interactionSource: MutableInteractionSource = remember { MutableInteractionSource() },
		) {
		if (checked != null) {
		Checkbox(
		checked = checked,
		onCheckedChange = wrapOnSwitchWithLog(onCheckedChange),
		enabled = changeable(),
		interactionSource = interactionSource,
		)
		} else {
		Checkbox(
		checked = false,
		onCheckedChange = null,
		enabled = false,
		interactionSource = interactionSource,
		)
		}
		}

packages/SettingsLib/Spa/tests/src/com/android/settingslib/spa/widget/preference/CheckboxPreferenceTest.kt

0 → 100644

+92 −0

Original line number	Diff line number	Diff line
		/*
		* Copyright (C) 2024 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 com.android.settingslib.spa.widget.preference

		import androidx.compose.runtime.Composable
		import androidx.compose.runtime.getValue
		import androidx.compose.runtime.mutableStateOf
		import androidx.compose.runtime.remember
		import androidx.compose.runtime.saveable.rememberSaveable
		import androidx.compose.runtime.setValue
		import androidx.compose.ui.test.assertIsDisplayed
		import androidx.compose.ui.test.assertIsOff
		import androidx.compose.ui.test.assertIsOn
		import androidx.compose.ui.test.isToggleable
		import androidx.compose.ui.test.junit4.createComposeRule
		import androidx.compose.ui.test.onNodeWithText
		import androidx.compose.ui.test.performClick
		import androidx.test.ext.junit.runners.AndroidJUnit4
		import org.junit.Rule
		import org.junit.Test
		import org.junit.runner.RunWith

		@RunWith(AndroidJUnit4::class)
		class CheckboxPreferenceTest {
		@get:Rule
		val composeTestRule = createComposeRule()

		@Test
		fun title_displayed() {
		composeTestRule.setContent {
		testCheckboxPreference(changeable = true)
		}

		composeTestRule.onNodeWithText("CheckboxPreference").assertIsDisplayed()
		}

		@Test
		fun toggleable_initialStateIsCorrect() {
		composeTestRule.setContent {
		testCheckboxPreference(changeable = true)
		}

		composeTestRule.onNode(isToggleable()).assertIsOff()
		}

		@Test
		fun click_changeable_withEffect() {
		composeTestRule.setContent {
		testCheckboxPreference(changeable = true)
		}

		composeTestRule.onNodeWithText("CheckboxPreference").performClick()
		composeTestRule.onNode(isToggleable()).assertIsOn()
		}

		@Test
		fun click_notChangeable_noEffect() {
		composeTestRule.setContent {
		testCheckboxPreference(changeable = false)
		}

		composeTestRule.onNodeWithText("CheckboxPreference").performClick()
		composeTestRule.onNode(isToggleable()).assertIsOff()
		}
		}

		@Composable
		private fun testCheckboxPreference(changeable: Boolean) {
		var checked by rememberSaveable { mutableStateOf(false) }
		CheckboxPreference(remember {
		object : CheckboxPreferenceModel {
		override val title = "CheckboxPreference"
		override val checked = { checked }
		override val changeable = { changeable }
		override val onCheckedChange = { newChecked: Boolean -> checked = newChecked }
		}
		})
		}
		No newline at end of file