Skip to content
ConsoleMonster
Class

PathHop

ConsoleMonster.Widgets

Edit on GitHub
Namespace
ConsoleMonster.Widgets
Assembly
ConsoleMonster
Source
PathHop.cs:33
Modifiers
sealed

A literal labelled hop with a stable identity, optional status and category chips.

Inheritance

  • object
  • PathHop

Usage

Explore 25 API references to this type

This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.

Returned or exposed by 11

Accepted by parameters 14

Constructors

public PathHop(string key, string label) #
PathHop.cs:33

Creates a path hop.

Parameters

key string required
Identity used to recognise shared hops across chains.
label string required
The plain text label.

Properties

public string Key { get; } #
PathHop.cs:18

The ordinal, case-sensitive hop identity.

public string Label { get; } #
PathHop.cs:21

The plain text label.

public StatusKind? Status { get; set; } #
PathHop.cs:24

An optional status, rendered with its glyph and theme role.

public ThemeToken? Role { get; set; } #
PathHop.cs:27

Optional label role, independent of the health marker.

public bool Bold { get; set; } #
PathHop.cs:30

Whether the hop label is bold.

public IList<string> Chips { get; } #
PathHop.cs:33

Plain text categories rendered by the existing chip presenter.

Extension Methods

public static PathHop AddChip(PathHop pathHop, string item) #

Adds an item to PathHop.Chips: Plain text categories rendered by the existing chip presenter.

Parameters

pathHop ConsoleMonster.Widgets.PathHop required
The instance.
item string required
The item.

Returns

PathHop The same instance.
AddChips 2 overloads
public static PathHop AddChips(PathHop pathHop, params string[] items) #

Adds items to PathHop.Chips: Plain text categories rendered by the existing chip presenter.

Parameters

pathHop ConsoleMonster.Widgets.PathHop required
The instance.
items string[] required
The items, in order.

Returns

PathHop The same instance.
public static PathHop AddChips(PathHop pathHop, IEnumerable<string> items) #

Adds items to PathHop.Chips: Plain text categories rendered by the existing chip presenter.

Parameters

pathHop ConsoleMonster.Widgets.PathHop required
The instance.
items System.Collections.Generic.IEnumerable<string> required
The items, in order.

Returns

PathHop The same instance.
Bold 2 overloads
public static PathHop Bold(PathHop pathHop, bool value) #

Sets PathHop.Bold: Whether the hop label is bold.

Parameters

pathHop ConsoleMonster.Widgets.PathHop required
The instance.
value bool required
The value.

Returns

PathHop The same instance.

Examples

// C# initializer or property    // C# fluent
pathHop.Bold = value;            pathHop.Bold(value);
public static PathHop Bold(PathHop pathHop) #

Sets PathHop.Bold to true.

Parameters

pathHop ConsoleMonster.Widgets.PathHop required
The instance to configure.

Returns

PathHop The same instance.
public static PathHop Role(PathHop pathHop, ThemeToken? value) #

Sets PathHop.Role: Optional label role, independent of the health marker.

Parameters

pathHop ConsoleMonster.Widgets.PathHop required
The instance.
value ConsoleMonster.Styling.ThemeToken? required
The value.

Returns

PathHop The same instance.

Examples

// C# initializer or property    // C# fluent
pathHop.Role = value;            pathHop.Role(value);
public static PathHop Status(PathHop pathHop, StatusKind? value) #

Sets PathHop.Status: An optional status, rendered with its glyph and theme role.

Parameters

pathHop ConsoleMonster.Widgets.PathHop required
The instance.
value ConsoleMonster.Styling.StatusKind? required
The value.

Returns

PathHop The same instance.

Examples

// C# initializer or property    // C# fluent
pathHop.Status = value;          pathHop.Status(value);