HtmlForgeX

API Reference

Class

EmailShippingProgress

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

Email-safe shipping/tracking progress card (tracking code + optional details + stepper + CTA). Designed for transactional emails (shipping updates, delivery confirmations).

Inheritance

Constructors

Methods

AddDetail 2 overloads
public EmailShippingProgress AddDetail(String key, String value) #
Returns: EmailShippingProgress

Adds a key/value row.

Parameters

key System.String requiredposition: 0
value System.String requiredposition: 1
public EmailShippingProgress AddDetail(Action<EmailKeyValueRow> configure) #
Returns: EmailShippingProgress

Adds a key/value row configured via callback.

Parameters

configure System.Action{HtmlForgeX.Email.EmailKeyValueRow} requiredposition: 0
public override String ToString() #
Returns: String
public EmailShippingProgress WithButton(String text, String href, EmailButtonStyle style = Primary, EmailButtonSize size = Medium, Boolean fullWidth = true) #
Returns: EmailShippingProgress

Sets CTA button.

Parameters

text System.String requiredposition: 0
href System.String requiredposition: 1
style HtmlForgeX.Email.EmailButtonStyle = Primary optionalposition: 2
size HtmlForgeX.Email.EmailButtonSize = Medium optionalposition: 3
fullWidth System.Boolean = true optionalposition: 4
public EmailShippingProgress WithStatus(EmailShippingStatus status, String text = null) #
Returns: EmailShippingProgress

Sets status.

Parameters

status HtmlForgeX.Email.EmailShippingStatus requiredposition: 0
text System.String = null optionalposition: 1
public EmailShippingProgress WithSubtitle(String subtitle) #
Returns: EmailShippingProgress

Sets subtitle.

Parameters

subtitle System.String requiredposition: 0
public EmailShippingProgress WithTitle(String title) #
Returns: EmailShippingProgress

Sets title.

Parameters

title System.String requiredposition: 0
public EmailShippingProgress WithTracking(String code, String href = null, String label = null) #
Returns: EmailShippingProgress

Sets tracking code.

Parameters

code System.String requiredposition: 0
href System.String = null optionalposition: 1
label System.String = null optionalposition: 2

Properties

public String Icon { get; set; } #

Optional icon shown on the left (emoji or short text).

public String Title { get; set; } #

Primary title.

public String Subtitle { get; set; } #

Optional subtitle under the title.

public EmailShippingStatus Status { get; set; } #

Status badge shown on the right.

public String StatusText { get; set; } #

Optional custom status text (overrides default).

public String TrackingCode { get; set; } #

Tracking code (e.g. "1Z999AA10123456784").

public String TrackingLabel { get; set; } #

Tracking code label shown above the code block.

public String TrackingHref { get; set; } #

Optional tracking URL for the code (makes it clickable).

public List<EmailKeyValueRow> Details { get; } #

Optional key/value rows (order id, carrier, ETA, etc.).

public EmailStepsIndicator Steps { get; } #

Steps indicator (progress).

public String BackgroundColor { get; set; } #

Background color (theme-aware by default).

public String BorderColor { get; set; } #

Border color.

public String BorderRadius { get; set; } #

Border radius.

public String CardPadding { get; set; } #

Card padding.

public String TitleColor { get; set; } #

Title color (theme-aware by default).

public String MutedColor { get; set; } #

Muted text color (subtitle, labels).

public String TrackingBackgroundColor { get; set; } #

Tracking code block background color.

public String TrackingBorderColor { get; set; } #

Tracking code block border color.

public String TrackingTextColor { get; set; } #

Tracking code text color.

public String TrackingFontSize { get; set; } #

Tracking code font size.

public String TrackingLetterSpacing { get; set; } #

Tracking code letter spacing.

public String TrackingPadding { get; set; } #

Tracking code padding.

public Boolean DashedTrackingBorder { get; set; } #

Whether to use a dashed border around the tracking code.

public String ButtonText { get; set; } #

Optional CTA button text.

public String ButtonHref { get; set; } #

Optional CTA button URL.

public EmailButtonStyle ButtonStyle { get; set; } #

CTA button style.

public EmailButtonSize ButtonSize { get; set; } #

CTA button size.

public Boolean FullWidthButton { get; set; } #

When true, renders the CTA button full width.