jchucomponents-ui-kmp/com.jeluchu.jchucomponents.ui.foundation.text/MarqueeText

MarqueeText

fun MarqueeText(text: String, modifier: Modifier = Modifier, textModifier: Modifier = Modifier, gradientEdgeColor: Color = Color.White, color: Color = Color.Unspecified, fontSize: TextUnit = TextUnit.Unspecified, fontStyle: FontStyle? = null, fontWeight: FontWeight? = null, fontFamily: FontFamily? = null, letterSpacing: TextUnit = TextUnit.Unspecified, textDecoration: TextDecoration? = null, textAlign: TextAlign? = null, lineHeight: TextUnit = TextUnit.Unspecified, overflow: TextOverflow = TextOverflow.Clip, softWrap: Boolean = true, onTextLayout: (TextLayoutResult) -> Unit = {}, style: TextStyle = LocalTextStyle.current)

Author: @Jeluchu

Auto scrollable text to display the content that is over passed to the view (This design element is estimated to be temporary until the Jetpack Compose team releases an official solution for this behavior that exists in XML)

Parameters

text

: es un texto

modifier

modifier that will be used to change the color, size...

gradientEdgeColor

: es un texto

color

Color to apply to the text

fontSize

the size of glyphs to use when painting the text. See TextStyle.fontSize

fontStyle

the typeface variant to use when drawing the letters (e.g., italic)

fontWeight

the typeface thickness to use when painting the text (e.g., FontWeight.Bold)

fontFamily

the font family to be used when rendering the text. See TextStyle.fontFamily

letterSpacing

the amount of space to add between each letter.

textDecoration

the decorations to paint on the text (e.g., an underline). See TextStyle.textDecoration

textAlign

the alignment of the text within the lines of the paragraph. See TextStyle.textAlign

lineHeight

line height for the Paragraph in TextUnit unit, e.g. SP or EM. See TextStyle.lineHeight

overflow

how visual overflow should be handled.

softWrap

whether the text should break at soft line breaks

onTextLayout

callback that is executed when a new text layout is calculated A TextLayoutResult object that callback provides contains paragraph information, size of the text, baselines and other details. The callback can be used to add additional decoration or functionality to the text

style

style configuration for the text such as color, font, line height etc.

@Composable

fun MarqueeText(text: String, modifier: Modifier = Modifier, color: Color = Color.Unspecified, fontSize: TextUnit = TextUnit.Unspecified, fontStyle: FontStyle? = null, fontWeight: FontWeight? = null, fontFamily: FontFamily? = null, letterSpacing: TextUnit = TextUnit.Unspecified, textDecoration: TextDecoration? = null, textAlign: TextAlign? = TextAlign.Center, lineHeight: TextUnit = TextUnit.Unspecified, overflow: TextOverflow = TextOverflow.Clip, softWrap: Boolean = true, iterations: Int = Int.MAX_VALUE, edgeWidthGradient: Dp = 10.dp, marqueeSpacing: MarqueeSpacing = MarqueeSpacing(30.dp), delayMillis: Int = RepeatDelayMillis, animationMode: MarqueeAnimationMode = MarqueeAnimationMode.Immediately, velocity: Dp = Velocity, maxLines: Int = Int.MAX_VALUE, onTextLayout: (TextLayoutResult) -> Unit = {}, style: TextStyle = LocalTextStyle.current)