Remote Compose Storybook Русский GitHub

Settings screen

Tap a switch; set wifi or brightness in the Host values tab.

Settings screen: the document drawn by the Remote Compose player
Open the live, interactive demo →

Change its controls, read the remote document it produces and the diff after every change.

What it is

A list of switches the user flips on the device and values the app keeps up to date.

Good for

  • Settings and preferences
  • Feature toggles shown in a remote screen

Code

The story's source with androidx.compose.remote imports. CI compiles every snippet on this site against AndroidX.

import androidx.compose.remote.creation.compose.action.combinedAction
import androidx.compose.remote.creation.compose.action.hostAction
import androidx.compose.remote.creation.compose.action.valueChangeAction
import androidx.compose.remote.creation.compose.layout.RemoteAlignment
import androidx.compose.remote.creation.compose.layout.RemoteArrangement
import androidx.compose.remote.creation.compose.layout.RemoteBox
import androidx.compose.remote.creation.compose.layout.RemoteCanvas
import androidx.compose.remote.creation.compose.layout.RemoteColumn
import androidx.compose.remote.creation.compose.layout.RemoteComposable
import androidx.compose.remote.creation.compose.layout.RemoteOffset
import androidx.compose.remote.creation.compose.layout.RemoteRow
import androidx.compose.remote.creation.compose.layout.RemoteSize
import androidx.compose.remote.creation.compose.layout.RemoteText
import androidx.compose.remote.creation.compose.modifier.RemoteModifier
import androidx.compose.remote.creation.compose.modifier.RemoteRole
import androidx.compose.remote.creation.compose.modifier.background
import androidx.compose.remote.creation.compose.modifier.clickable
import androidx.compose.remote.creation.compose.modifier.clip
import androidx.compose.remote.creation.compose.modifier.fillMaxWidth
import androidx.compose.remote.creation.compose.modifier.height
import androidx.compose.remote.creation.compose.modifier.padding
import androidx.compose.remote.creation.compose.modifier.semantics
import androidx.compose.remote.creation.compose.modifier.size
import androidx.compose.remote.creation.compose.modifier.stateDescription
import androidx.compose.remote.creation.compose.modifier.width
import androidx.compose.remote.creation.compose.shapes.RemoteCircleShape
import androidx.compose.remote.creation.compose.shapes.RemoteRoundedCornerShape
import androidx.compose.remote.creation.compose.state.MutableRemoteBoolean
import androidx.compose.remote.creation.compose.state.RemotePaint
import androidx.compose.remote.creation.compose.state.rc
import androidx.compose.remote.creation.compose.state.rdp
import androidx.compose.remote.creation.compose.state.rememberNamedRemoteBoolean
import androidx.compose.remote.creation.compose.state.rememberNamedRemoteFloat
import androidx.compose.remote.creation.compose.state.rf
import androidx.compose.remote.creation.compose.state.rs
import androidx.compose.runtime.Composable
import androidx.compose.runtime.remember
import androidx.compose.ui.graphics.Color

@Composable
@RemoteComposable
fun SettingSwitch(label: String, checked: MutableRemoteBoolean, accent: Color) {
    RemoteRow(
        RemoteModifier.fillMaxWidth()
            .clickable(
                combinedAction(
                    valueChangeAction(checked, !checked),
                    hostAction(label.rs, !checked),
                ),
                role = RemoteRole.Switch,
            )
            .semantics { stateDescription = checked.select("On".rs, "Off".rs) }
            .padding(horizontal = 16.rdp, vertical = 12.rdp),
        verticalAlignment = RemoteAlignment.CenterVertically,
    ) {
        RemoteText(label.rs, modifier = RemoteModifier.weight(1f.rf))
        RemoteBox(
            RemoteModifier.size(44.rdp, 26.rdp)
                .clip(RemoteRoundedCornerShape(13.rdp))
                .background(checked.select(accent.rc, Color(0xFFBDBDBD).rc))
                .padding(3.rdp),
            contentAlignment = RemoteAlignment.CenterStart,
        ) {
            // The knob slides by its start padding, chosen by the state on the device.
            RemoteBox(
                RemoteModifier.padding(start = checked.select(18.rdp, 0.rdp))
                    .size(20.rdp)
                    .clip(RemoteCircleShape)
                    .background(Color.White.rc),
            )
        }
    }
}

/** A settings screen: switches whose state is kept on the device, each also reported to the app. */
@Composable
@RemoteComposable
fun SettingsScreen(accent: Color) {
    val wifi = rememberNamedRemoteBoolean("wifi", true)
    val notifications = remember { MutableRemoteBoolean(true) }
    val darkMode = remember { MutableRemoteBoolean(false) }
    val brightness = rememberNamedRemoteFloat("brightness", 0.6f.rf)
    RemoteColumn(
        RemoteModifier.width(320.rdp)
            .clip(RemoteRoundedCornerShape(20.rdp))
            .background(Color.White.rc)
            .padding(vertical = 8.rdp),
    ) {
        RemoteRow(
            RemoteModifier.fillMaxWidth().padding(horizontal = 16.rdp, vertical = 12.rdp),
            verticalAlignment = RemoteAlignment.CenterVertically,
        ) {
            RemoteText("Wi-Fi (set by the app)".rs, modifier = RemoteModifier.weight(1f.rf))
            RemoteText(wifi.select("On".rs, "Off".rs), color = accent.rc)
        }
        SettingSwitch("Notifications", notifications, accent)
        SettingSwitch("Dark mode", darkMode, accent)
        RemoteColumn(
            RemoteModifier.fillMaxWidth().padding(horizontal = 16.rdp, vertical = 12.rdp),
            verticalArrangement = RemoteArrangement.spacedBy(8.rdp),
        ) {
            RemoteText("Brightness (set by the app)".rs)
            RemoteCanvas(RemoteModifier.fillMaxWidth().height(8.rdp)) {
                drawRoundRect(
                    RemotePaint { color = Color(0xFFE0E0E0).rc },
                    size = size,
                    cornerRadius = RemoteOffset(4f.rf, 4f.rf),
                )
                drawRoundRect(
                    RemotePaint { color = accent.rc },
                    size = RemoteSize(width * brightness, height),
                    cornerRadius = RemoteOffset(4f.rf, 4f.rf),
                )
            }
        }
    }
}

API

creation.compose.modifier.semantics

RemoteModifier semantics(RemoteModifier, optional boolean mergeDescendants, RemoteSemanticsPropertyReceiver.() -> Unit properties)

creation.compose.state.rememberNamedRemoteBoolean

RemoteBoolean rememberNamedRemoteBoolean(String name, boolean initialValue, optional RemoteState.Domain domain)

Reference

More in Recipes