richtext-ui/com.halilibo.richtext.ui

Package-level declarations

Types

BlockQuoteGutter

interface BlockQuoteGutter

A composable function that draws the gutter beside a BlockQuote.

data class CodeBlockStyle(val textStyle: TextStyle? = null, val modifier: Modifier? = null, val padding: TextUnit? = null, val wordWrap: Boolean? = null)

Defines how CodeBlocks are rendered.

typealias HeadingStyle = (level: Int, textStyle: TextStyle) -> TextStyle

Function that computes the TextStyle for the given header level, given the current TextStyle for this point in the composition. Note that the TextStyle passed into this function will be fully resolved. The returned style will then be merged with the passed-in text style, so any unspecified properties will be inherited.

data class InfoPanelStyle(val contentPadding: PaddingValues? = null, val background: @Composable (InfoPanelType) -> Modifier? = null, val textStyle: @Composable (InfoPanelType) -> TextStyle? = null)

enum InfoPanelType : Enum<InfoPanelType>

data class ListStyle(val markerIndent: TextUnit? = null, val contentsIndent: TextUnit? = null, val itemSpacing: TextUnit? = null, val orderedMarkers: RichTextScope.() -> OrderedMarkers? = null, val unorderedMarkers: RichTextScope.() -> UnorderedMarkers? = null)

Defines how FormattedLists should look.

enum ListType : Enum<ListType>

interface OrderedMarkers

Defines how to draw list markers for FormattedLists that are Ordered.

object RichTextScope

Scope object for composables that can draw rich text.

data class RichTextStyle(val paragraphSpacing: TextUnit? = null, val headingStyle: HeadingStyle? = null, val listStyle: ListStyle? = null, val blockQuoteGutter: BlockQuoteGutter? = null, val codeBlockStyle: CodeBlockStyle? = null, val tableStyle: TableStyle? = null, val infoPanelStyle: InfoPanelStyle? = null, val stringStyle: RichTextStringStyle? = null)

Configures all formatting attributes for drawing rich text.

RichTextTableCellScope

interface RichTextTableCellScope

RichTextTableRowScope

interface RichTextTableRowScope

data class TableStyle(val headerTextStyle: TextStyle? = null, val cellPadding: TextUnit? = null, val borderColor: Color? = null, val borderStrokeWidth: Float? = null)

Defines the visual style for a Table.

UnorderedMarkers

interface UnorderedMarkers

Defines how to draw list markers for FormattedLists that are Unordered.

Functions

fun BasicRichText(modifier: Modifier = Modifier, style: RichTextStyle? = null, children: @Composable RichTextScope.() -> Unit)

Draws some rich text. Entry point to the compose-richtext library.

fun RichTextScope.BlockQuote(children: @Composable RichTextScope.() -> Unit)

Draws a block quote, with a BlockQuoteGutter drawn beside the children on the start side.

fun RichTextScope.CodeBlock(wordWrap: Boolean? = null, children: @Composable RichTextScope.() -> Unit)

fun RichTextScope.CodeBlock(text: String, wordWrap: Boolean? = null)

A specially-formatted block of text that typically uses a monospace font with a tinted background.

DisableScrollbar

fun DisableScrollbar(content: @Composable () -> Unit)

Contextually disables scrollbar for Desktop CodeBlocks under content tree.

inline fun RichTextScope.FormattedList(listType: ListType, vararg children: @Composable RichTextScope.() -> Unit)

fun <T> RichTextScope.FormattedList(listType: ListType, items: List<T>, startIndex: Int = 0, drawItem: @Composable RichTextScope.(T) -> Unit)

Creates a formatted list such as a bullet list or numbered list.

fun RichTextScope.Heading(level: Int, children: @Composable RichTextScope.() -> Unit)

fun RichTextScope.Heading(level: Int, text: String)

A section heading.

fun RichTextScope.HorizontalRule()

A simple horizontal line drawn with the current content color.

fun RichTextScope.InfoPanel(infoPanelType: InfoPanelType, content: @Composable () -> Unit)

A panel to show content similar to Bootstrap alerts, categorized as InfoPanelType.

fun RichTextScope.InfoPanel(infoPanelType: InfoPanelType, text: String)

A panel to show content similar to Bootstrap alerts, categorized as InfoPanelType. This composable is a shortcut to show only text in an info panel.

fun RichTextStyle.merge(otherStyle: RichTextStyle?): RichTextStyle

painterUnorderedMarkers

fun painterUnorderedMarkers(vararg painters: Painter): UnorderedMarkers

Creates an UnorderedMarkers that will cycle through the values in painters for each indentation level.

resolveDefaults

fun RichTextStyle.resolveDefaults(): RichTextStyle

RichTextThemeProvider

fun RichTextThemeProvider(textStyleProvider: @Composable () -> TextStyle? = null, textStyleBackProvider: @Composable (TextStyle, @Composable () -> Unit) -> Unit? = null, contentColorProvider: @Composable () -> Color? = null, contentColorBackProvider: @Composable (Color, @Composable () -> Unit) -> Unit? = null, content: @Composable () -> Unit)

Entry point for integrating app's own typography and theme system with RichText.

fun RichTextScope.Table(modifier: Modifier = Modifier, headerRow: RichTextTableCellScope.() -> Unit? = null, bodyRows: RichTextTableRowScope.() -> Unit)

Draws a table with an optional header row, and an arbitrary number of body rows.

textOrderedMarkers

fun RichTextScope.textOrderedMarkers(vararg markers: (index: Int) -> String): OrderedMarkers

Creates an OrderedMarkers that will cycle through the values in markers for each indentation level given the index.

textUnorderedMarkers

fun @Composable RichTextScope.textUnorderedMarkers(vararg markers: String): UnorderedMarkers

Creates an UnorderedMarkers that will cycle through the values in markers for each indentation level.

fun RichTextScope.WithStyle(style: RichTextStyle?, children: @Composable RichTextScope.() -> Unit)

Sets the RichTextStyle for its children.

Properties

currentRichTextStyle

@get:Composable

val RichTextScope.currentRichTextStyle: RichTextStyle

The current RichTextStyle.