stripe-ui-core/com.stripe.android.uicore.text/Html

Html

@Composable
@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP])
fun Html(html: String, modifier: Modifier = Modifier, imageLoader: Map<String, EmbeddableImage> = emptyMap(), color: Color = Color.Unspecified, style: TextStyle = LocalTextStyle.current, enabled: Boolean = true, urlSpanStyle: SpanStyle = SpanStyle(textDecoration = TextDecoration.Underline), imageAlign: PlaceholderVerticalAlign = PlaceholderVerticalAlign.AboveBaseline, onClick: () -> Unit = {})

This will display html annotated text in a string. Images cannot be embedded in link tags. The following tags are supported: , , , , ,

  • Local/remote sources value in the img tab, must map to something in the imageLoader.

    When an img tag does not map to a EmbeddableImage, then this will use StripeImageLoader to retrieve the images and only renders once the images are downloaded.

    When the text is clicked, the FIRST parsed URL from is opened through Intent.ACTION_VIEW.

    Parameters

    html

    The HTML to render

    imageLoader

    data source mapping img tags with images

    color

    The color of the text defaults to Color.Unspecified

    enabled

    Whether URLs should be clickable or not, defaults to true

    urlSpanStyle

    The style given to URLs, defaults to TextDecoration.Underline

    imageAlign

    The vertical alignment for the image in relation to the text, defaults to PlaceholderVerticalAlign.AboveBaseline

    onClick

    Additional callback when the URL is opened.