multiplatform-markdown-renderer/com.mikepenz.markdown

Package com.mikepenz.markdown

Types

Link copied to clipboard
fun interface BulletHandler
Content copied to clipboard

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

Link copied to clipboard
@Stable
interface MarkdownColors
Content copied to clipboard

Represents the colors of the text, background and content used in a markdown component.

Link copied to clipboard
object MarkdownDefaults
Content copied to clipboard

Contains the default values used by Markdown.

Link copied to clipboard
@Stable
interface MarkdownTypography
Content copied to clipboard

Represents the type scale for the Markdown.

Functions

Link copied to clipboard
@Composable
fun Code(    code: String,     modifier: Modifier = Modifier,     colors: MarkdownColors)
Content copied to clipboard

A composable that receives some source code as String and renders it in the UI.

Link copied to clipboard
@Composable
fun fetchImage(url: String): ImageBitmap?
Content copied to clipboard
Link copied to clipboard
fun ASTNode.findChildOfTypeRecursive(type: IElementType): ASTNode?
Content copied to clipboard

Find a child node recursive

Link copied to clipboard
suspend fun loadPicture(url: String): ImageBitmap?
Content copied to clipboard
Link copied to clipboard
@Composable
fun Markdown(    content: String,     modifier: Modifier = Modifier.fillMaxSize(),     colors: MarkdownColors = MarkdownDefaults.markdownColors(),     typography: MarkdownTypography = MarkdownDefaults.markdownTypography(),     flavour: MarkdownFlavourDescriptor = GFMFlavourDescriptor())
Content copied to clipboard

A composable that receives markdown content as String and renders it in the UI.

Properties

Link copied to clipboard
val LocalBulletListHandler: ProvidableCompositionLocal<BulletHandler>
Content copied to clipboard

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

Link copied to clipboard
val LocalOrderedListHandler: ProvidableCompositionLocal<BulletHandler>
Content copied to clipboard

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

Link copied to clipboard
const val TAG_IMAGE_URL: String
Content copied to clipboard

Tag used to indicate an image url for inline content. Required for rendering.

Link copied to clipboard
const val TAG_URL: String
Content copied to clipboard

Tag used to indicate an url for inline content. Required for click handling.