multiplatform-markdown-renderer-m3/com.mikepenz.markdown.m3

Package-level declarations

Functions

fun Markdown(markdownState: MarkdownState, colors: MarkdownColors = markdownColor(), typography: MarkdownTypography = 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(checkbox = { MarkdownCheckBox(it.content, it.node, it.typography.text) }), 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) })

@Composable

fun Markdown(state: State, colors: MarkdownColors = markdownColor(), typography: MarkdownTypography = 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(checkbox = { MarkdownCheckBox(it.content, it.node, it.typography.text) }), 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) })

@Composable

fun Markdown(content: String, colors: MarkdownColors = markdownColor(), typography: MarkdownTypography = 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(checkbox = { MarkdownCheckBox(it.content, it.node, it.typography.text) }), 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 markdown content using Material 3 styles.

markdownColor

@Composable

fun markdownColor(text: Color = MaterialTheme.colorScheme.onBackground, codeBackground: Color = MaterialTheme.colorScheme.onBackground.copy(alpha = 0.1f), inlineCodeBackground: Color = codeBackground, dividerColor: Color = MaterialTheme.colorScheme.outlineVariant, tableBackground: Color = MaterialTheme.colorScheme.onBackground.copy(alpha = 0.02f)): MarkdownColors

markdownTypography

@Composable

fun markdownTypography(h1: TextStyle = MaterialTheme.typography.displayLarge, h2: TextStyle = MaterialTheme.typography.displayMedium, h3: TextStyle = MaterialTheme.typography.displaySmall, h4: TextStyle = MaterialTheme.typography.headlineMedium, h5: TextStyle = MaterialTheme.typography.headlineSmall, h6: TextStyle = MaterialTheme.typography.titleLarge, text: TextStyle = MaterialTheme.typography.bodyLarge, code: TextStyle = MaterialTheme.typography.bodyMedium.copy(fontFamily = FontFamily.Monospace), inlineCode: TextStyle = text.copy(fontFamily = FontFamily.Monospace), quote: TextStyle = MaterialTheme.typography.bodyMedium.plus(SpanStyle(fontStyle = FontStyle.Italic)), paragraph: TextStyle = MaterialTheme.typography.bodyLarge, ordered: TextStyle = MaterialTheme.typography.bodyLarge, bullet: TextStyle = MaterialTheme.typography.bodyLarge, list: TextStyle = MaterialTheme.typography.bodyLarge, textLink: TextLinkStyles = TextLinkStyles( style = MaterialTheme.typography.bodyLarge.copy( fontWeight = FontWeight.Bold, textDecoration = TextDecoration.Underline ).toSpanStyle() ), table: TextStyle = text): MarkdownTypography