Table of Contents

Class BOBTimeline

Namespace
BlazOrbit.Components
Assembly
BlazOrbit.dll
[GenerateComponentInfo]
public class BOBTimeline : BOBComponentBase, IHasSize
Inheritance
object
ComponentBase
BOBTimeline
Implements
Inherited Members

Constructors

BOBTimeline() 

public BOBTimeline()

Properties

Alternating

When true and Orientation is vertical, alternate odd/even entries to opposite sides of the rail. Ignored for horizontal layouts.

[Parameter]
public bool Alternating { get; set; }

Property Value

bool

DateFormat

Custom format for the per-day header. Defaults to yyyy-MM-dd.

[Parameter]
public string DateFormat { get; set; }

Property Value

string

GroupByDate

When true and the orientation is vertical, group entries under a per-day header derived from Timestamp.

[Parameter]
public bool GroupByDate { get; set; }

Property Value

bool

ItemTemplate

Custom rendering for the body of an entry. Defaults to title + description.

[Parameter]
public RenderFragment<TimelineItem>? ItemTemplate { get; set; }

Property Value

RenderFragment<TimelineItem>

Items

Sequence of events rendered along the timeline rail.

[Parameter]
public IReadOnlyList<TimelineItem>? Items { get; set; }

Property Value

IReadOnlyList<TimelineItem>

Orientation

Layout direction. Defaults to Vertical.

[Parameter]
public BOBTimelineOrientation Orientation { get; set; }

Property Value

BOBTimelineOrientation

Size

Visual size of the marker dots and inner icons.

[Parameter]
public BOBSize Size { get; set; }

Property Value

BOBSize

TimeFormat

Custom format for each entry's timestamp label. Defaults to HH:mm.

[Parameter]
public string TimeFormat { get; set; }

Property Value

string

Methods

BuildRenderTree(RenderTreeBuilder)

Renders the component to the supplied Microsoft.AspNetCore.Components.Rendering.RenderTreeBuilder.

protected override void BuildRenderTree(RenderTreeBuilder __builder)

Parameters

__builder RenderTreeBuilder
Edit this page