RemoteDocumentPreview

Functions summary

Unit	@Composable RemoteDocumentPreview(remoteDocument: RemoteDocument, modifier: Modifier) Displays a RemoteDocument in the Android Studio Preview.
Unit	@Composable RemoteDocumentPreview(     document: ByteArray,     modifier: Modifier,     profile: Profile? ) Displays a RemoteDocument in the Android Studio Preview from a ByteArray.

Functions

RemoteDocumentPreview

Artifact: androidx.compose.remote:remote-tooling-preview

View Source

Added in 1.0.0-alpha21

@Composable
fun RemoteDocumentPreview(
    remoteDocument: RemoteDocument,
    modifier: Modifier = Modifier
): Unit

Displays a RemoteDocument in the Android Studio Preview.

This composable is intended for use within Android Studio to preview the content of a RemoteDocument. It handles setting up the necessary Remote Compose player environment.

Parameters
remoteDocument: RemoteDocument	The RemoteDocument containing the content to be displayed.
modifier: Modifier = Modifier	The modifier to be applied to the box containing the preview.

RemoteDocumentPreview

Artifact: androidx.compose.remote:remote-tooling-preview

View Source

Added in 1.0.0-alpha21

@Composable
fun RemoteDocumentPreview(
    document: ByteArray,
    modifier: Modifier = Modifier,
    profile: Profile? = null
): Unit

Displays a RemoteDocument in the Android Studio Preview from a ByteArray.

This is a convenience overload that takes the raw document bytes directly and optionally configures the document buffer with profile before inflating the RemoteDocument.

Parameters
document: ByteArray	The raw byte array representing the RemoteDocument.
modifier: Modifier = Modifier	The modifier to be applied to the box containing the preview.
profile: Profile? = null	Optional Profile used to configure the document buffer before inflation.