HtmlForgeX

API Reference

Class

EmailStepsIndicator

Namespace HtmlForgeX.Email
Assembly HtmlForgeX.Email
Base Element
Implements
Modifiers sealed

Email-safe steps indicator (stepper) rendered using table markup. Useful for shipping/order progress, onboarding sequences, and multi-step workflows.

Inheritance

Constructors

Methods

AddStep 2 overloads
public EmailStepsIndicator AddStep(Action<EmailStep> configure) #
Returns: EmailStepsIndicator

Adds a step configured via callback.

Parameters

configure System.Action{HtmlForgeX.Email.EmailStep} requiredposition: 0
public EmailStepsIndicator AddStep(String title, String subtitle = "", EmailStepStatus status = Upcoming, String href = null) #
Returns: EmailStepsIndicator

Adds a step.

Parameters

title System.String requiredposition: 0
subtitle System.String = "" optionalposition: 1
status HtmlForgeX.Email.EmailStepStatus = Upcoming optionalposition: 2
href System.String = null optionalposition: 3
public EmailStepsIndicator SetCurrentStep(Int32 index) #
Returns: EmailStepsIndicator

Convenience helper that sets a single current step and marks previous steps as completed.

Parameters

index System.Int32 requiredposition: 0
public override String ToString() #
Returns: String

Properties

public List<EmailStep> Steps { get; } #

Steps rendered by the component.

public EmailStepsLayout Layout { get; set; } #

Layout of the steps indicator.

public Int32 CircleSizePx { get; set; } #

Circle size in pixels.

public Int32 CircleFontSizePx { get; set; } #

Circle font size in pixels.

public Int32 ConnectorThicknessPx { get; set; } #

Connector thickness in pixels.

public Int32 VerticalConnectorHeightPx { get; set; } #

Vertical connector height (only used in vertical layout).

public String LabelGap { get; set; } #

Gap between circle row and label row (horizontal layout).

public String TitleColor { get; set; } #

Title color.

public String SubtitleColor { get; set; } #

Subtitle color.

public String TrackColor { get; set; } #

Track/connector color (upcoming).

public String AccentColor { get; set; } #

Accent color (completed connector + completed circle).

public String ErrorColor { get; set; } #

Error color.

public Boolean ShowSubtitles { get; set; } #

Whether to render subtitles if provided.