rememberNamedRemote* · Named enum
An enum a host can set by name.
Open the live, interactive demo →
Change its controls, read the remote document it produces and the diff after every change.
What it is
Values with a name, such as a title or a colour, that the app showing the screen can change later without the server sending a new design.
Good for
- Live scores and prices
- Personalised greetings
- Theme colours chosen by the app
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.layout.RemoteComposable
import androidx.compose.remote.creation.compose.layout.RemoteText
import androidx.compose.remote.creation.compose.state.rememberNamedRemoteEnum
import androidx.compose.remote.creation.compose.state.rs
import androidx.compose.remote.creation.compose.state.rsp
import androidx.compose.runtime.Composable
enum class Screen {
Loading,
Content,
Error,
}
@Composable
@RemoteComposable
fun NamedEnum(initial: Screen) {
val screen = rememberNamedRemoteEnum("screen", initial)
RemoteText("screen = ".rs + screen.toRemoteString { it.name.rs }, fontSize = 20.rsp)
}
API
creation.compose.state.rememberNamedRemoteString
RemoteString rememberNamedRemoteString(String name, String defaultValue, optional RemoteState.Domain domain)creation.compose.state.rememberNamedRemoteFloat
RemoteFloat rememberNamedRemoteFloat(String name, RemoteFloat defaultValue, optional RemoteState.Domain domain)creation.compose.state.rememberNamedRemoteColor
RemoteColor rememberNamedRemoteColor(String name, RemoteColor defaultValue, optional RemoteState.Domain domain)creation.compose.state.rememberNamedRemoteBoolean
RemoteBoolean rememberNamedRemoteBoolean(String name, boolean initialValue, optional RemoteState.Domain domain)creation.compose.state.rememberNamedRemoteInt
RemoteInt rememberNamedRemoteInt(String name, int defaultValue, optional RemoteState.Domain domain)creation.compose.state.rememberNamedRemoteEnum
inline <reified T extends java.lang.Enum<T>> RemoteEnum<T> rememberNamedRemoteEnum(String name, T initialValue, optional RemoteState.Domain domain)
<T extends java.lang.Enum<T>> RemoteEnum<T> rememberNamedRemoteEnum(String name, T initialValue, enums.EnumEntries<T> enumEntries, optional RemoteState.Domain domain)