Package-level declarations

Properties

Link copied to clipboard

The CompositionLocal to provide functionality related to transforming the bullet of an ordered list

Link copied to clipboard

The CompositionLocal to provide functionality related to transforming the bullet of an ordered list

Functions

Link copied to clipboard
fun LazyMarkdownSuccess(state: State.Success, components: MarkdownComponents, modifier: Modifier = Modifier, contentPadding: PaddingValues = PaddingValues(0.dp))

Renders the parsed markdown content in a LazyColumn.

Link copied to clipboard
fun Markdown(markdownState: MarkdownState, colors: MarkdownColors, typography: MarkdownTypography, modifier: Modifier = Modifier.fillMaxSize(), padding: MarkdownPadding = markdownPadding(), dimens: MarkdownDimens = markdownDimens(), imageTransformer: ImageTransformer = NoOpImageTransformerImpl(), annotator: MarkdownAnnotator = markdownAnnotator(), extendedSpans: MarkdownExtendedSpans = markdownExtendedSpans(), inlineContent: MarkdownInlineContent = markdownInlineContent(), components: MarkdownComponents = markdownComponents(), animations: MarkdownAnimations = markdownAnimations(), loading: @Composable (modifier: Modifier) -> Unit = { Box(modifier) }, success: @Composable (state: State.Success, components: MarkdownComponents, modifier: Modifier) -> Unit = { state, components, modifier -> MarkdownSuccess(state = state, components = components, modifier = modifier) }, error: @Composable (modifier: Modifier) -> Unit = { Box(modifier) })

Renders markdown content using a pre-created MarkdownState object.

fun Markdown(state: State, colors: MarkdownColors, typography: MarkdownTypography, modifier: Modifier = Modifier.fillMaxSize(), padding: MarkdownPadding = markdownPadding(), dimens: MarkdownDimens = markdownDimens(), imageTransformer: ImageTransformer = NoOpImageTransformerImpl(), annotator: MarkdownAnnotator = markdownAnnotator(), extendedSpans: MarkdownExtendedSpans = markdownExtendedSpans(), inlineContent: MarkdownInlineContent = markdownInlineContent(), components: MarkdownComponents = markdownComponents(), animations: MarkdownAnimations = markdownAnimations(), loading: @Composable (modifier: Modifier) -> Unit = { Box(modifier) }, success: @Composable (state: State.Success, components: MarkdownComponents, modifier: Modifier) -> Unit = { state, components, modifier -> MarkdownSuccess(state = state, components = components, modifier = modifier) }, error: @Composable (modifier: Modifier) -> Unit = { Box(modifier) })

Renders markdown content using a State object directly.

fun Markdown(content: String, colors: MarkdownColors, typography: MarkdownTypography, modifier: Modifier = Modifier.fillMaxSize(), padding: MarkdownPadding = markdownPadding(), dimens: MarkdownDimens = markdownDimens(), flavour: MarkdownFlavourDescriptor = GFMFlavourDescriptor(), parser: MarkdownParser = MarkdownParser(flavour), imageTransformer: ImageTransformer = NoOpImageTransformerImpl(), annotator: MarkdownAnnotator = markdownAnnotator(), extendedSpans: MarkdownExtendedSpans = markdownExtendedSpans(), inlineContent: MarkdownInlineContent = markdownInlineContent(), components: MarkdownComponents = markdownComponents(), animations: MarkdownAnimations = markdownAnimations(), referenceLinkHandler: ReferenceLinkHandler = ReferenceLinkHandlerImpl(), loading: @Composable (modifier: Modifier) -> Unit = { Box(modifier) }, success: @Composable (state: State.Success, components: MarkdownComponents, modifier: Modifier) -> Unit = { state, components, modifier -> MarkdownSuccess(state = state, components = components, modifier = modifier) }, error: @Composable (modifier: Modifier) -> Unit = { Box(modifier) })

Renders the provided markdown content string using Jetpack Compose.

Link copied to clipboard
fun MarkdownElement(node: ASTNode, components: MarkdownComponents, content: String, includeSpacer: Boolean = true)

Handles the rendering of a markdown element based on its ASTNode.type.

Link copied to clipboard
fun MarkdownSuccess(state: State.Success, components: MarkdownComponents, modifier: Modifier = Modifier)

Renders the successfully parsed markdown content in a Column layout.