richtext-ui/com.halilibo.richtext.ui

Package-level declarations

Types

A composable function that draws the gutter beside a BlockQuote.

data class CodeBlockStyle(val textStyle: ERROR CLASS: Symbol not found for TextStyle?? = null, val modifier: ERROR CLASS: Symbol not found for Modifier?? = null, val padding: ERROR CLASS: Symbol not found for TextUnit?? = null, val wordWrap: Boolean? = null)

Defines how CodeBlocks are rendered.

HeadingStyle

typealias HeadingStyle = (level: Int, @R|kotlin/ParameterName|(name = String(textStyle)) ERROR CLASS: Symbol not found for TextStyle) -> ERROR CLASS: Symbol not found for 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.

InfoPanelStyle

data class InfoPanelStyle(val contentPadding: ERROR CLASS: Symbol not found for PaddingValues?? = null, val background: (InfoPanelType) -> ERROR CLASS: Symbol not found for Modifier? = null, val textStyle: (InfoPanelType) -> ERROR CLASS: Symbol not found for TextStyle? = null)

InfoPanelType

enum InfoPanelType : Enum<InfoPanelType>

ListStyle

data class ListStyle(val markerIndent: ERROR CLASS: Symbol not found for TextUnit?? = null, val contentsIndent: ERROR CLASS: Symbol not found for TextUnit?? = null, val itemSpacing: ERROR CLASS: Symbol not found for TextUnit?? = null, val orderedMarkers: RichTextScope.() -> OrderedMarkers? = null, val unorderedMarkers: RichTextScope.() -> UnorderedMarkers? = null)

Defines how FormattedLists should look.

ListType

enum ListType : Enum<ListType>

OrderedMarkers

interface OrderedMarkers

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

RichTextScope

object RichTextScope

Scope object for composables that can draw rich text.

RichTextStyle

data class RichTextStyle(val paragraphSpacing: ERROR CLASS: Symbol not found for 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

TableStyle

data class TableStyle(val headerTextStyle: ERROR CLASS: Symbol not found for TextStyle?? = null, val cellPadding: ERROR CLASS: Symbol not found for TextUnit?? = null, val borderColor: ERROR CLASS: Symbol not found for 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.

Properties

currentRichTextStyle

val RichTextScope.currentRichTextStyle: RichTextStyle

The current RichTextStyle.

Functions

BasicRichText

fun BasicRichText(modifier: ERROR CLASS: Symbol not found for Modifier = Modifier, style: RichTextStyle? = null, children: RichTextScope.() -> Unit)

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

BlockQuote

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

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

CodeBlock

fun RichTextScope.CodeBlock(wordWrap: Boolean? = null, children: 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

@Composable

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

Contextually disables scrollbar for Desktop CodeBlocks under content tree.

FormattedList

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

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

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

Heading

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

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

A section heading.

HorizontalRule

fun RichTextScope.HorizontalRule()

A simple horizontal line drawn with the current content color.

InfoPanel

fun RichTextScope.InfoPanel(infoPanelType: InfoPanelType, content: () -> 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.

merge

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

painterUnorderedMarkers

fun painterUnorderedMarkers(vararg painters: ERROR CLASS: Symbol not found for 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: () -> ERROR CLASS: Symbol not found for TextStyle? = null, textStyleBackProvider: (ERROR CLASS: Symbol not found for TextStyle, () -> Unit) -> Unit? = null, contentColorProvider: () -> ERROR CLASS: Symbol not found for Color? = null, contentColorBackProvider: (ERROR CLASS: Symbol not found for Color, () -> Unit) -> Unit? = null, content: () -> Unit)

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

Table

fun RichTextScope.Table(modifier: ERROR CLASS: Symbol not found for 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 RichTextScope.textUnorderedMarkers(vararg markers: String): UnorderedMarkers

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

WithStyle

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

Sets the RichTextStyle for its children.