core/com.orange.ouds.core.component/OudsLink

OudsLink

fun OudsLink(label: String, icon: OudsLink.Icon?, onClick: () -> Unit, modifier: Modifier = Modifier, size: OudsLink.Size = OudsLinkDefaults.Size, enabled: Boolean = true)

OUDS Link design guidelines

Links are interactive elements that allow users to navigate to a new screen, website, or a specific section within the current screen.

This API manage the display of text only and text + icon links. If you need a navigation link, you can use the other API available for this component which display a text with a back or next chevron.

Note that in the case it is placed in an OudsColoredBox, its monochrome variant is automatically displayed. Some tokens associated with these specific colors can be customized and are identified with the Mono suffix (for instance OudsLinkTokens.colorContentEnabledMono).

Parameters

label

Label describing what is being linked to.

icon

Icon displayed in the link that can be used to indicate the destination or type of content being referenced.

onClick

Callback invoked when the link is clicked.

modifier

Modifier applied to the link.

size

Size of the link. See OudsLink.Size for available sizes.

enabled

Controls the enabled state of the link. When false, the link will not be clickable.

Samples

import android.R
import androidx.compose.runtime.Composable
import androidx.compose.ui.res.painterResource
import com.orange.ouds.core.component.OudsLink

fun main() { 
   //sampleStart 
   OudsLink(
    label = "Link",
    icon = OudsLink.Icon(painterResource(id = R.drawable.star_on)),
    onClick = { /* Do something! */ },
) 
   //sampleEnd
}

@Composable

fun OudsLink(label: String, arrow: OudsLink.Arrow, onClick: () -> Unit, modifier: Modifier = Modifier, size: OudsLink.Size = OudsLinkDefaults.Size, enabled: Boolean = true)