Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit f80f42ac authored by Chaohui Wang's avatar Chaohui Wang
Browse files

New ComposePreference 

And ComposePreferenceController.

So we can use Spa in Preferences based UI.

Bug: 280864229
Test: unit test
Change-Id: Ida6dc62b54de9513d014ad899a65876d3499a02c
parent ad3dede7

res/layout/preference_compose.xml

0 → 100644
+21 −0
Original line number Diff line number Diff line 
<?xml version="1.0" encoding="utf-8"?>

<!--

  ~ 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.

  -->



<androidx.compose.ui.platform.ComposeView

    xmlns:android="http://schemas.android.com/apk/res/android"

    android:layout_width="match_parent"

    android:layout_height="wrap_content" />

src/com/android/settings/spa/preference/ComposePreference.kt

0 → 100644
+53 −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.settings.spa.preference



import android.content.Context

import android.util.AttributeSet

import androidx.compose.runtime.Composable

import androidx.compose.ui.platform.ComposeView

import androidx.compose.ui.platform.ViewCompositionStrategy

import androidx.preference.Preference

import androidx.preference.PreferenceViewHolder

import com.android.settings.R

import com.android.settingslib.spa.framework.theme.SettingsTheme



class ComposePreference @JvmOverloads constructor(

    context: Context,

    attrs: AttributeSet? = null,

    defStyleAttr: Int = 0,

    defStyleRes: Int = 0,

) : Preference(context, attrs, defStyleAttr, defStyleRes) {

    var content: @Composable () -> Unit = {}



    init {

        layoutResource = R.layout.preference_compose

    }



    override fun onBindViewHolder(holder: PreferenceViewHolder) {

        super.onBindViewHolder(holder)



        (holder.itemView as ComposeView).apply {

            setViewCompositionStrategy(ViewCompositionStrategy.DisposeOnViewTreeLifecycleDestroyed)

            setContent {

                SettingsTheme {

                    content()

                }

            }

        }

    }

}

src/com/android/settings/spa/preference/ComposePreferenceController.kt

0 → 100644
+37 −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.settings.spa.preference



import android.content.Context

import androidx.compose.runtime.Composable

import androidx.preference.PreferenceScreen

import com.android.settings.core.BasePreferenceController



abstract class ComposePreferenceController(context: Context, preferenceKey: String) :

    BasePreferenceController(context, preferenceKey) {



    private lateinit var preference: ComposePreference



    override fun displayPreference(screen: PreferenceScreen) {

        super.displayPreference(screen)

        preference = screen.findPreference(preferenceKey)!!

        preference.content = { Content() }

    }



    @Composable

    abstract fun Content()

}

tests/spa_unit/src/com/android/settings/spa/preference/ComposePreferenceControllerTest.kt

0 → 100644
+73 −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.settings.spa.preference



import android.content.Context

import androidx.compose.material3.Text

import androidx.compose.runtime.Composable

import androidx.compose.ui.test.assertIsDisplayed

import androidx.compose.ui.test.junit4.createComposeRule

import androidx.compose.ui.test.onNodeWithText

import androidx.preference.PreferenceManager

import androidx.test.core.app.ApplicationProvider

import androidx.test.ext.junit.runners.AndroidJUnit4

import org.junit.Rule

import org.junit.Test

import org.junit.runner.RunWith



@RunWith(AndroidJUnit4::class)

class ComposePreferenceControllerTest {



    @get:Rule

    val composeTestRule = createComposeRule()



    private val context: Context = ApplicationProvider.getApplicationContext()



    private val controller = object : ComposePreferenceController(

        context = context,

        preferenceKey = TEST_KEY,

    ) {

        override fun getAvailabilityStatus() = AVAILABLE



        @Composable

        override fun Content() {

            Text(TEXT)

        }

    }



    private val preference = ComposePreference(context).apply {

        key = TEST_KEY

    }



    private val preferenceScreen = PreferenceManager(context).createPreferenceScreen(context)

        .apply { addPreference(preference) }



    @Test

    fun displayPreference() {

        controller.displayPreference(preferenceScreen)



        composeTestRule.setContent {

            preference.content()

        }

        composeTestRule.onNodeWithText(TEXT).assertIsDisplayed()

    }



    private companion object {

        const val TEST_KEY = "test_key"

        const val TEXT = "Text"

    }

}

tests/spa_unit/src/com/android/settings/spa/preference/ComposePreferenceTest.kt

0 → 100644
+61 −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.settings.spa.preference



import android.content.Context

import androidx.compose.material3.Text

import androidx.compose.ui.platform.ComposeView

import androidx.compose.ui.test.assertIsDisplayed

import androidx.compose.ui.test.junit4.createComposeRule

import androidx.compose.ui.test.onNodeWithText

import androidx.preference.PreferenceViewHolder

import androidx.test.core.app.ApplicationProvider

import androidx.test.ext.junit.runners.AndroidJUnit4

import org.junit.Rule

import org.junit.Test

import org.junit.runner.RunWith



@RunWith(AndroidJUnit4::class)

class ComposePreferenceTest {



    @get:Rule

    val composeTestRule = createComposeRule()



    private val context: Context = ApplicationProvider.getApplicationContext()



    private val preference = ComposePreference(context)



    private val composeView = ComposeView(context)



    @Test

    fun onBindViewHolder() {

        preference.content = {

            Text(TEXT)

        }



        preference.onBindViewHolder(PreferenceViewHolder.createInstanceForTests(composeView))



        composeTestRule.setContent {

            composeView.Content()

        }

        composeTestRule.onNodeWithText(TEXT).assertIsDisplayed()

    }



    private companion object {

        const val TEXT = "Text"

    }

}