Struct FlowChrome

Namespace

SharpConsoleUI.Flows

Assembly

SharpConsoleUI.dll

Chrome hints supplied to a flow step when building its content. The host uses these to size and decorate the host window; the content may read them to size its own body.

public readonly struct FlowChrome

Inherited Members

ValueType.Equals(object)

ValueType.GetHashCode()

ValueType.ToString()

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Extension Methods

BindingExtensions.BindTwoWay<TBuilder, TControl, TSource, TValue>(TBuilder, TSource, Expression<Func<TSource, TValue>>, Expression<Func<TControl, TValue>>)

BindingExtensions.BindTwoWay<TBuilder, TControl, TSource, TSrc, TTgt>(TBuilder, TSource, Expression<Func<TSource, TSrc>>, Expression<Func<TControl, TTgt>>, Func<TSrc, TTgt>, Func<TTgt, TSrc>)

BindingExtensions.Bind<TBuilder, TControl, TSource, TValue>(TBuilder, TSource, Expression<Func<TSource, TValue>>, Expression<Func<TControl, TValue>>)

BindingExtensions.Bind<TBuilder, TControl, TSource, TSrc, TTgt>(TBuilder, TSource, Expression<Func<TSource, TSrc>>, Expression<Func<TControl, TTgt>>, Func<TSrc, TTgt>)

Constructors

FlowChrome(string, (int Index, int? Count)?, int?, int?, IReadOnlyList<FlowButton>?, Func<IReadOnlyList<FlowButton>>?, NotificationSeverityEnum, bool, bool)

Initialises a FlowChrome value.

public FlowChrome(string title, (int Index, int? Count)? stepIndicator = null, int? widthHint = null, int? heightHint = null, IReadOnlyList<FlowButton>? buttons = null, Func<IReadOnlyList<FlowButton>>? refreshButtons = null, NotificationSeverityEnum severity = NotificationSeverityEnum.None, bool autoSizeHeight = false, bool resizable = false)

Parameters

title string

The window or dialog title.

stepIndicator (int Index, int? Count)?

Optional step-position indicator, e.g. (2, 4) for "step 2 of 4".

widthHint int?

Optional preferred width of the host window in columns.

heightHint int?

Optional preferred height of the host window in rows.

buttons IReadOnlyList<FlowButton>

The concrete button list to render. When null or omitted an empty list is used; the host typically populates this from the chosen FlowButtons set.

refreshButtons Func<IReadOnlyList<FlowButton>>

Optional delegate the host calls on each StateChanged to re-evaluate the button row's enabled state in place (dynamic buttons). When null the host leaves the button enabled state unchanged on state changes. Supplied by the wizard; primitives and Tier-A leave it null.

severity NotificationSeverityEnum

Optional severity that controls the host-built top band's glyph and accent-rule colour role. The host always builds the top band; None (the default) renders a glyph-less bold title on a Primary rule, while Info/Success/Warning/Danger render the matching severity glyph and rule role. Additive trailing parameter — existing FlowChrome construction is unaffected.

autoSizeHeight bool

When true and HeightHint is null, the host auto-sizes the window height to the content (clamped to a min floor and a terminal-derived cap; it scrolls beyond the cap). An explicit HeightHint always overrides this. Default false.

resizable bool

When true, the host lets the user drag-resize the window (minimize/maximize buttons stay disabled). Independent of AutoSizeHeight: the initial height is chosen by the normal rule, and this only allows manual resize afterward. Default false.

Properties

AutoSizeHeight

When true and HeightHint is null, the host auto-sizes the window height to the content (clamped to a min floor and a terminal-derived cap; it scrolls beyond the cap). An explicit HeightHint always overrides this. Default false.

public bool AutoSizeHeight { get; }

Property Value

bool

Buttons

The standardized button row to render. Built by the host from the chosen FlowButtons set plus any per-step label or enable overrides. Defaults to an empty list when not provided.

public IReadOnlyList<FlowButton> Buttons { get; }

Property Value

IReadOnlyList<FlowButton>

HeightHint

Optional preferred height of the host window in terminal rows.

public int? HeightHint { get; }

Property Value

int?

RefreshButtons

Optional delegate invoked by the host on each StateChanged to re-compute the button row's enabled state in place (dynamic buttons). Returns the refreshed button list (same labels/verdicts, updated Enabled); the host applies each enabled flag to the live button without rebuilding the window. null means no dynamic re-evaluation. Supplied by the wizard (Tier B); null for primitives/Tier A.

public Func<IReadOnlyList<FlowButton>>? RefreshButtons { get; }

Property Value

Func<IReadOnlyList<FlowButton>>

Resizable

When true, the host lets the user drag-resize the window (minimize/maximize buttons stay disabled). Independent of AutoSizeHeight: the initial height is chosen by the normal rule, and this only allows manual resize afterward. Default false.

public bool Resizable { get; }

Property Value

bool

Severity

The severity that drives the host-built top band's glyph and accent-rule colour role. None (the default) renders the bold title with no glyph on a Primary rule; Info/Success/Warning/Danger render the matching glyph and rule role. The host always builds the top band from this value, so primitives, plain custom content, and wizard steps all show a consistent title band.

public NotificationSeverityEnum Severity { get; }

Property Value

NotificationSeverityEnum

StepIndicator

Optional step position, e.g. (Index: 2, Count: 4). Count may be null for flows with a dynamic or unknown number of steps.

public (int Index, int? Count)? StepIndicator { get; }

Property Value

(int Index, int? Count)?

Title

The window or dialog title text.

public string Title { get; }

Property Value

string

WidthHint

Optional preferred width of the host window in terminal columns.

public int? WidthHint { get; }

Property Value

int?