Skip to content

What ConsoleMonster draws, live and printed once.
- Widgets Every widget at every colour and glyph tier.
- Tables Width negotiation, cards, presenters and totals.
- Live dashboards Recorded runs, replayed frame by frame.
- Demos Ready-made programs to run, copy and make your own.
- Live runs Many items in parallel, watch views and Pester runs.
- Interactive Prompts, menus, forms and the grid.
- PowerShell Cmdlets on 5.1 and 7, with their real output.
Install, configure and look things up.
- Docs Install, detection, themes, live sessions, recording.
- Guides Coming from Write-Color, Spectre.Console or Format-Table.
- .NET API Every public type and member.
- Commands Every cmdlet with its parameters.
- Benchmarks Frame cost, update rates and memory.
Current section: .NET API

Struct

FrameState

ConsoleMonster.Frames

Namespace: ConsoleMonster.Frames
Assembly: ConsoleMonster
Source: FrameState.cs:33
Base: ValueType
Modifiers: sealed

One state fact on a title line: glyph, count and word, coloured by its state.

Inheritance

ValueType
FrameState

Usage

Explore 13 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 5

Accepted by parameters 8

Extension method FrameHeader.AddState parameter item
Extension method FrameHeader.AddStates parameter items
Method FrameHeaderFluent.AddState parameter item
Method FrameHeaderFluent.AddStates parameter items
Extension method FrameSection.AddState parameter item
Extension method FrameSection.AddStates parameter items
Method FrameSectionFluent.AddState parameter item
Method FrameSectionFluent.AddStates parameter items

Methods

public static FrameState Healthy(string word) #

FrameState.cs:37

A single healthy verdict, such as ✓ all healthy.

Parameters

word string required: The literal verdict.

Returns

FrameState The state fact.

public static FrameState Of(HealthState state, long count, string word) #

FrameState.cs:33

A counted state, such as × 2 failing. Zero counts are dropped by the frame.

Parameters

state ConsoleMonster.Frames.HealthState required: The state.
count long required: The count.
word string required: The literal word.

Returns

FrameState The state fact.

Inherited Methods

Properties

public HealthState State { get; } #

FrameState.cs:40

The state.

public long? Count { get; } #

FrameState.cs:42

The count, or null for a verdict.

public string Word { get; } #

FrameState.cs:44

The literal word.