PdfLink

Composable that wraps content in a clickable URL annotation for PDF output.

@Composable
fun PdfLink(
    href: String,
    modifier: Modifier = Modifier,
    content: @Composable () -> Unit,
)

Parameters

Parameter Type Default Description
href String – Target URL for the link (must not be blank)
modifier Modifier Modifier Modifier applied to the link wrapper
content @Composable () -> Unit – Content that forms the clickable region

Behavior

Inside renderToPdf: The bounds of content are measured via onGloballyPositioned and recorded. After rendering, a PDAnnotationLink is added to the PDF page at that position with an invisible border.

Outside renderToPdf: This is a no-op wrapper – the content renders normally with no link behavior. This makes it safe to use in composables shared between screen UI and PDF output.

Validation

Throws IllegalArgumentException if href is blank or empty.

Examples 

// Text link
PdfLink(href = "https://example.com") {
    Text("Click me", color = Color.Blue, textDecoration = TextDecoration.Underline)
}

// Button-style link
PdfLink(href = "https://example.com") {
    Box(
        Modifier
            .clip(RoundedCornerShape(8.dp))
            .background(Color.Blue)
            .padding(horizontal = 24.dp, vertical = 12.dp),
    ) {
        Text("Get Started", color = Color.White, fontWeight = FontWeight.Bold)
    }
}

// Email link
PdfLink(href = "mailto:hello@example.com") {
    Text("hello@example.com", color = Color.Blue)
}

See also