Class

UiConstruction

ConsoleMonster

Edit on GitHub

Namespace: ConsoleMonster
Assembly: ConsoleMonster
Source: Ui.Construction.cs:14
Modifiers: static

Configuration endings for factories whose identity or representation is fixed at construction.

Inheritance

object
UiConstruction

Methods

Build 8 overloads

public static IWidget Build(ChartOptions options) #

Ui.Construction.cs:14

Creates the selected chart through the shared validated factory.

Parameters

options ConsoleMonster.Widgets.ChartOptions required: The configured definition.

Returns

IWidget The chart.

public static IWidget Build(ProgressOptions options) #

Ui.Construction.cs:16

Creates determinate or indeterminate progress through the shared validated factory.

Parameters

options ConsoleMonster.Widgets.ProgressOptions required: The configured definition.

Returns

IWidget The indicator.

public static InputControl Build(SelectInputOptions options) #

Ui.Construction.cs:22

Creates single or multiple selection through the shared input factory.

Parameters

options ConsoleMonster.Interactive.SelectInputOptions required: The configured definition.

Returns

InputControl The control.

public static InputControl Build(TextInputOptions options) #

Ui.Construction.cs:24

Creates single-line or multiline text through the shared input factory.

Parameters

options ConsoleMonster.Interactive.TextInputOptions required: The configured definition.

Returns

InputControl The control.

public static Button Build(ButtonInputOptions options) #

Ui.Construction.cs:26

Creates a button through the shared input factory.

Parameters

options ConsoleMonster.Interactive.ButtonInputOptions required: The configured definition.

Returns

Button The button.

public static Toggle Build(ToggleInputOptions options) #

Ui.Construction.cs:28

Creates a toggle through the shared input factory.

Parameters

options ConsoleMonster.Interactive.ToggleInputOptions required: The configured definition.

Returns

Toggle The toggle.

public static AppBinding Build(BindingOptions options) #

Ui.Construction.cs:30

Creates a state binding after its callback and identity have been configured.

Parameters

options ConsoleMonster.Interactive.BindingOptions required: The configured definition.

Returns

AppBinding The binding.

public static AppCommand Build(CommandOptions options) #

Ui.Construction.cs:32

Creates an asynchronous action after its immutable identity and callback have been configured.

Parameters

options ConsoleMonster.Interactive.CommandOptions required: The configured definition.

Returns

AppCommand The command.

Build``1 2 overloads

public static T Build<T>(ChartOptions options) #

Ui.Construction.cs:18

Materializes a numeric chart and verifies the concrete handle type.

Type Parameters

T: The expected renderer.

Parameters

options ConsoleMonster.Widgets.ChartOptions required: The definition.

Returns

T The typed renderer.

public static T Build<T>(ProgressOptions options) #

Ui.Construction.cs:20

Materializes progress and verifies the concrete handle type.

Type Parameters

T: The expected renderer.

Parameters

options ConsoleMonster.Widgets.ProgressOptions required: The definition.

Returns

T The typed renderer.

public static LiveSession CreateSession(IWidget widget, LiveSessionOptions? options = null) #

Ui.Construction.cs:34

Creates an owned live-session lifetime over a configured widget; dispose it after running.

Parameters

widget ConsoleMonster.Layout.IWidget required: The session root.
options ConsoleMonster.Live.LiveSessionOptions? = null optional: The session options.

Returns

LiveSession The new session.

Export 2 overloads

public static void Export(ChartOptions definition, string path, string? format = null, ExportOptions? options = null, IFrameExportProvider? provider = null)

Ui.Construction.cs:38

Exports the configured definition through the shared core/add-on dispatcher.

Parameters

definition ConsoleMonster.Widgets.ChartOptions required: The configured definition.
path string required: The destination.
format string? = null optional: The format.
options ConsoleMonster.Export.ExportOptions? = null optional: The export options.
provider ConsoleMonster.Export.IFrameExportProvider? = null optional: An optional add-on provider.

public static void Export(ProgressOptions definition, string path, string? format = null, ExportOptions? options = null, IFrameExportProvider? provider = null)

Ui.Construction.cs:42

Exports the configured definition through the shared core/add-on dispatcher.

Parameters

definition ConsoleMonster.Widgets.ProgressOptions required: The configured definition.
path string required: The destination.
format string? = null optional: The format.
options ConsoleMonster.Export.ExportOptions? = null optional: The export options.
provider ConsoleMonster.Export.IFrameExportProvider? = null optional: An optional add-on provider.

Show 2 overloads

public static void Show(ChartOptions definition, TerminalProfile? profile = null, ITerminalWriter? writer = null) #

Ui.Construction.cs:36

Displays the configured definition through the shared widget pipeline.

Parameters

definition ConsoleMonster.Widgets.ChartOptions required: The configured definition.
profile ConsoleMonster.Capabilities.TerminalProfile? = null optional: The terminal profile.
writer ConsoleMonster.Output.ITerminalWriter? = null optional: The output writer.

public static void Show(ProgressOptions definition, TerminalProfile? profile = null, ITerminalWriter? writer = null) #

Ui.Construction.cs:40

Displays the configured definition through the shared widget pipeline.

Parameters

definition ConsoleMonster.Widgets.ProgressOptions required: The configured definition.
profile ConsoleMonster.Capabilities.TerminalProfile? = null optional: The terminal profile.
writer ConsoleMonster.Output.ITerminalWriter? = null optional: The output writer.

Inheritance

Methods

Inherited Methods