RemoteContentPreview

Functions summary

Unit
@Composable
RemoteContentPreview(
    modifier: Modifier,
    profile: Profile,
    content: @RemoteComposable @Composable () -> Unit
)

Displays a Remote Compose Composable in the Android Studio Preview.

Functions

@Composable
fun RemoteContentPreview(
    modifier: Modifier = Modifier,
    profile: Profile = RcPlatformProfiles.ANDROIDX,
    content: @RemoteComposable @Composable () -> Unit
): Unit

Displays a Remote Compose Composable in the Android Studio Preview.

This function captures the provided content using the specified profile and renders it as a RemoteDocument to simulate how it would appear when played back in a remote context.

Parameters
modifier: Modifier = Modifier

The modifier to be applied to the box containing the preview.

profile: Profile = RcPlatformProfiles.ANDROIDX

The Profile defining the target environment for the remote content. Defaults to RcPlatformProfiles.ANDROIDX.

content: @RemoteComposable @Composable () -> Unit

The Composable content to be captured and previewed. It does not have be annotated with @RemoteComposable.