API Reference

Class

MenuContext

Namespace ConsoleMonster.Interactive

Assembly ConsoleMonster

Modifiers sealed

What an action gets from the menu: the item, the submitted form values, prompts drawn over the app, toasts, a live dashboard run that returns to the menu with a results summary, and navigation.

Inheritance

Object
MenuContext

Usage

Explore 19 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 8

Method MenuItem.Action parameter action
Method MenuItem.ActionAsync parameter action
Method MenuItem.Form parameter submitted
Method MenuItem.LoadChoices parameter loader
Method MenuItem.Page parameter page
Method MenuItem.Review parameter review
Constructor PaletteCommand.PaletteCommand parameter invoke
Method RunResult.Next parameter action

Methods

public T? Ask<T>(Prompt<T?> prompt) #

MenuContext.cs:51

Returns: T?

Asks a prompt in front of the app and returns the answer.

Type Parameters

T: The answer type.

Parameters

prompt ConsoleMonster.Interactive.Prompt<T?> requiredposition: 0: The prompt.

Returns

The answer.

public Boolean Confirm(String question, Boolean defaultValue = false) #

MenuContext.cs:57

Returns: Boolean

Asks a yes/no question in front of the app.

Parameters

question System.String requiredposition: 0: The question.
defaultValue System.Boolean = false optionalposition: 1: The default answer.

Returns

The answer.

public Void Exit() #

MenuContext.cs:78

Returns: Void

Leaves the menu.

public Void Log(String text, StatusKind status = Info) #

MenuContext.cs:87

Returns: Void

Reports a line of output from the action. While the app owns the screen the line is kept and shown when the action returns (a toast for one line, an output dialog for several) instead of being drawn over the app; in the inline layout it is written to the console.

Parameters

text System.String requiredposition: 0: The line.
status ConsoleMonster.Styling.StatusKind = Info optionalposition: 1: Info for plain output, Warn or Fail to colour it.

public Void Open(MenuItem item) #

MenuContext.cs:75

Returns: Void

Opens an item (its submenu, form, selection or page).

Parameters

item ConsoleMonster.Interactive.MenuItem requiredposition: 0: The item.

public RunResult Run(IWidget dashboard, Func<RunContext, RunResult?> work, LiveSessionOptions? options = null) #

MenuContext.cs:67

Returns: RunResult

Runs work with a live dashboard on the app's screen; when the work returns, the menu comes back and shows the result with its next actions. Prompts during the run pause the dashboard and appear in front of it.

Parameters

dashboard ConsoleMonster.Layout.IWidget requiredposition: 0: The dashboard.
work System.Func<ConsoleMonster.Interactive.RunContext, ConsoleMonster.Interactive.RunResult?> requiredposition: 1: The work; returns the result to show (null shows a plain "done").
options ConsoleMonster.Live.LiveSessionOptions? = null optionalposition: 2: Live session options; the output is managed by the menu.

Returns

The result.

public Void ShowResult(RunResult result) #

MenuContext.cs:71

Returns: Void

Shows a result page (summary and next actions) in the content area.

Parameters

result ConsoleMonster.Interactive.RunResult requiredposition: 0: The result.

public Void Toast(String text, StatusKind status = Pass) #

MenuContext.cs:45

Returns: Void

Shows a short notice in the footer.

Parameters

text System.String requiredposition: 0: The text.
status ConsoleMonster.Styling.StatusKind = Pass optionalposition: 1: The status (mark and colour).