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

Package-level declarations

Types

An interface of providing use case specific un/ordered list handling.

class DefaultMarkdownAnnotator(val annotate: AnnotatedString.Builder.(content: String, child: ASTNode) -> Boolean?) : MarkdownAnnotator

DefaultMarkdownColors

@Immutable

class DefaultMarkdownColors(val text: Color, val codeText: Color, val inlineCodeText: Color, val linkText: Color, val codeBackground: Color, val inlineCodeBackground: Color, val dividerColor: Color) : MarkdownColors

DefaultMarkdownExtendedSpans

@Immutable

class DefaultMarkdownExtendedSpans(val extendedSpans: @Composable () -> ExtendedSpans?) : MarkdownExtendedSpans

DefaultMarkdownTypography

@Immutable

class DefaultMarkdownTypography(val h1: TextStyle, val h2: TextStyle, val h3: TextStyle, val h4: TextStyle, val h5: TextStyle, val h6: TextStyle, val text: TextStyle, val code: TextStyle, val inlineCode: TextStyle, val quote: TextStyle, val paragraph: TextStyle, val ordered: TextStyle, val bullet: TextStyle, val list: TextStyle, val link: TextStyle) : MarkdownTypography

ImageData

@Immutable

data class ImageData(val painter: Painter, val modifier: Modifier = Modifier.fillMaxWidth(), val contentDescription: String? = "Image", val alignment: Alignment = Alignment.CenterStart, val contentScale: ContentScale = ContentScale.Fit, val alpha: Float = DefaultAlpha, val colorFilter: ColorFilter? = null)

ImageTransformer

interface ImageTransformer

MarkdownAnnotator

interface MarkdownAnnotator

MarkdownColors

@Stable

interface MarkdownColors

MarkdownDimens

interface MarkdownDimens

MarkdownExtendedSpans

interface MarkdownExtendedSpans

MarkdownPadding

interface MarkdownPadding

MarkdownTypography

interface MarkdownTypography

NoOpImageTransformerImpl

class NoOpImageTransformerImpl : ImageTransformer

PlaceholderConfig

@Immutable

data class PlaceholderConfig(val size: Size, val verticalAlign: PlaceholderVerticalAlign = PlaceholderVerticalAlign.Bottom, val animate: Boolean = true)

ReferenceLinkHandler

interface ReferenceLinkHandler

Interface to describe the ReferenceLinkHandler

ReferenceLinkHandlerImpl

class ReferenceLinkHandlerImpl : ReferenceLinkHandler

Implementation for ReferenceLinkHandler to resolve referenced link within the Markdown

Functions

markdownAnnotator

@Composable

fun markdownAnnotator(annotate: AnnotatedString.Builder.(content: String, child: ASTNode) -> Boolean? = null): MarkdownAnnotator

markdownDimens

@Composable

fun markdownDimens(dividerThickness: Dp = 1.dp, codeBackgroundCornerSize: Dp = 8.dp, blockQuoteThickness: Dp = 2.dp): MarkdownDimens

markdownExtendedSpans

@Composable

fun markdownExtendedSpans(extendedSpans: @Composable () -> ExtendedSpans? = null): MarkdownExtendedSpans

markdownPadding

@Composable

fun markdownPadding(block: Dp = 2.dp, list: Dp = 8.dp, listItemBottom: Dp = 4.dp, indentList: Dp = 8.dp, codeBlock: PaddingValues = PaddingValues(8.dp), blockQuote: PaddingValues = PaddingValues(horizontal = 16.dp, vertical = 0.dp), blockQuoteText: PaddingValues = PaddingValues(vertical = 4.dp), blockQuoteBar: PaddingValues.Absolute = PaddingValues.Absolute(left = 4.dp, top = 2.dp, right = 4.dp, bottom = 2.dp)): MarkdownPadding