core/com.michaelflisar.composechangelog.renderer/SimpleRenderer

SimpleRenderer

class SimpleRenderer(val tag: String, val label: String, val showTag: Boolean = true, val color: @Composable () -> Color = { LocalContentColor.current }) : IChangelogItemRenderer

a simple renderer that can render a xml tag

this renderer supports following child structure:

... // 0 to n times ... // 0 to n times

the tag is used to render a single item and is the one that is rendered by this renderer

tag: the tag to render tag: the label for this tag showTag: if true, the tag will be shown above the release header (colored dot + text) color: the color of the tag (used for the dot in the release header and is passed on to the next region lambda)

Constructors

SimpleRenderer

constructor(tag: String, label: String, showTag: Boolean = true, color: @Composable () -> Color = { LocalContentColor.current })

Types

Companion

object Companion

Properties

color

val color: @Composable () -> Color

label

val label: String

showTag

val showTag: Boolean

tag

val tag: String

Functions

canRender

open override fun canRender(item: XMLTag): Boolean

Checks if this renderer can render the given item. The first renderer that returns true will be used to render the item.

headerTag

@Composable

open override fun headerTag(): IChangelogItemRenderer.HeaderTag?

If this item has a header tag, it will be used to display a tag in the release header. This is optional and can be used to display additional information about the item type.

render

@Composable

open override fun render(setup: Changelog.Setup, item: XMLTag)

Renders the given item. The setup is passed to provide additional information about the changelog