Skip to content

PlaceholderWorkloadBuilderExtensions

Namespace: Hex1b

Assembly: Hex1b.dll

Builder extensions for configuring a placeholder workload that drives the terminal until the real ("primary") workload signals it is ready.

csharp
[Experimental("HEX1B002", UrlFormat = "https://github.com/hex1b/hex1b/blob/main/docs/experimental/placeholder.md")]
public static class PlaceholderWorkloadBuilderExtensions

Inheritance

ObjectPlaceholderWorkloadBuilderExtensions

Methods

WithPlaceholderHex1bApp(Hex1bTerminalBuilder, Func<Hex1bApp, Func<RootContext, Hex1bWidget>>, Action<Hex1bAppOptions>?, PlaceholderResumePolicy)

Convenience overload that configures a as the placeholder.

Parameters:

Returns: Hex1bTerminalBuilder

csharp
public static Hex1bTerminalBuilder WithPlaceholderHex1bApp(this Hex1bTerminalBuilder builder, Func<Hex1bApp, Func<RootContext, Hex1bWidget>> configure, Action<Hex1bAppOptions>? configureOptions = null, PlaceholderResumePolicy resumePolicy = PlaceholderResumePolicy.OnDisconnect)

WithPlaceholderWorkload(Hex1bTerminalBuilder, Action<Hex1bTerminalBuilder>, PlaceholderResumePolicy)

Wraps the already-configured workload (the primary) with a that initially streams from the placeholder workload built by configurePlaceholder, then swaps to the primary once it is ready.

Parameters:

  • builder (Hex1bTerminalBuilder): The terminal builder whose primary workload is being decorated.
  • configurePlaceholder (Action<Hex1bTerminalBuilder>): Configures the placeholder using a fresh . Only workload-shaped configuration is honoured (e.g. WithHex1bApp); presentation, mouse, scrollback and filter settings on the inner builder are ignored — the outer terminal owns those.
  • resumePolicy (PlaceholderResumePolicy): What to do if the primary workload disconnects after going active. Defaults to .

Returns: Hex1bTerminalBuilder

csharp
public static Hex1bTerminalBuilder WithPlaceholderWorkload(this Hex1bTerminalBuilder builder, Action<Hex1bTerminalBuilder> configurePlaceholder, PlaceholderResumePolicy resumePolicy = PlaceholderResumePolicy.OnDisconnect)

Released under the MIT License.