jetlime/com.pushpal.jetlime

Package-level declarations

Types

Represents an animation configuration for an event point in a UI component. This animation defines how an event point (circle) should animate, including its initial value, target value, and the specification of the animation.

EventPointType

@Immutable

class EventPointType

Represents a type of event point in a UI component with an optional icon. This class is used to define different types of event points such as empty, filled, or custom types with specific icons.

EventPosition

@Immutable

class EventPosition

Represents a position of an event within a sequence, such as the start, middle, or end. This class encapsulates the logic for determining the position based on the index in a list.

HorizontalAlignment

@Stable

enum HorizontalAlignment : Enum<HorizontalAlignment>

Enum representing the alignment of the timeline line and points for JetLimeRow.

ItemsList

@Immutable

class ItemsList<T>(val items: List<T>)

An immutable list class that holds a list of items of type T.

JetLimeDefaults

object JetLimeDefaults

Provides default values and utility functions for JetLimeColumn or JetLimeRow styling.

JetLimeEventDefaults

object JetLimeEventDefaults

Provides default values and utility functions for JetLimeEvent styling.

JetLimeEventStyle

@Immutable

class JetLimeEventStyle

Represents the style configuration for an event in a JetLimeEvent UI component. This class encapsulates various styling properties such as position, point type, colors, radius, animation, and stroke attributes for an event point.

JetLimeStyle

@Immutable

class JetLimeStyle

Represents the styling configuration for JetLimeColumn and JetLimeRow components.

VerticalAlignment

@Stable

enum VerticalAlignment : Enum<VerticalAlignment>

Enum representing the alignment of the timeline line and points for JetLimeColumn.

Properties

LocalJetLimeStyle

val LocalJetLimeStyle: ProvidableCompositionLocal<JetLimeStyle>

A CompositionLocal providing the current JetLimeStyle.

Functions

JetLimeColumn

@Composable

fun <T> JetLimeColumn(itemsList: ItemsList<T>, modifier: Modifier = Modifier, style: JetLimeStyle = JetLimeDefaults.columnStyle(), listState: LazyListState = rememberLazyListState(), contentPadding: PaddingValues = PaddingValues(0.dp), key: (index: Int, item: T) -> Any? = null, itemContent: @Composable (index: Int, T, EventPosition) -> Unit)

A composable function that creates a vertical timeline interface with a list of items.

JetLimeEvent

@Composable

fun JetLimeEvent(modifier: Modifier = Modifier, style: JetLimeEventStyle = JetLimeEventDefaults.eventStyle(EventPosition.END), content: @Composable () -> Unit)

Composable function for creating a JetLimeColumn or JetLimeRow event.

JetLimeExtendedEvent

@Composable

fun JetLimeExtendedEvent(modifier: Modifier = Modifier, style: JetLimeEventStyle = JetLimeEventDefaults.eventStyle(EventPosition.END), additionalContent: @Composable BoxScope.() -> Unit = { }, additionalContentMaxWidth: Dp = AdditionalContentMaxWidth, content: @Composable () -> Unit)

Should only be used with a JetLimeColumn for a vertical arrangement of events.

JetLimeRow

@Composable

fun <T> JetLimeRow(itemsList: ItemsList<T>, modifier: Modifier = Modifier, style: JetLimeStyle = JetLimeDefaults.rowStyle(), listState: LazyListState = rememberLazyListState(), contentPadding: PaddingValues = PaddingValues(0.dp), key: (index: Int, item: T) -> Any? = null, itemContent: @Composable (index: Int, T, EventPosition) -> Unit)

A composable function that creates a horizontal timeline interface with a list of items.