New-ImageConsoleStoryTab

Namespace ImagePlayground

Inputs

None

Outputs

ImagePlayground.PowerShell.ImageConsoleStoryStep

Creates a persistent tab in an ImagePlayground console story.

Remarks

By default, the new tab opens and becomes active after the current tab's configured reading dwell. Use Active for the initial tab, Background to pre-stage a visible inactive tab, and Select-ImageConsoleStoryTab to revisit any existing tab without clearing its buffer.

Examples

Authored help example

Define the initial active PowerShell tab

PS>


New-ImageConsoleStoryTab -Id PowerShell -Title 'PowerShell' -Profile PowerShell -Active

Names and styles the initial persistent tab without creating an extra transition.

Open an Ubuntu tab

PS>


New-ImageConsoleStoryTab -Id ubuntu -Profile Ubuntu -Title Ubuntu -WorkingDirectory '~/src'

Opens and activates an Ubuntu-styled Bash session only after the previous tab has finished its configured reading dwell.

Prepare a background tab for a later jump

PS>


New-ImageConsoleStoryTab -Id logs -Title Logs -Profile PowerShell -Background
            Select-ImageConsoleStoryTab -Id logs

The declaration makes the tab available in the strip without interrupting the active session. Selection later activates its retained buffer.

Common Parameters

This command supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable.

For more information, see about_CommonParameters.

Syntax

New-ImageConsoleStoryTab -Id <String> [-Palette <TerminalTheme>] [-Profile <PowerShell|WindowsPowerShell|Ubuntu|Bash|CommandPrompt>] [-Title <String>] [-TransitionSeconds <Double>] [-WorkingDirectory <String>] [<CommonParameters>]

Parameter set: Open

Parameters

Id String requiredposition: 0pipeline: False: Stable identifier used by later tab-selection steps.
Palette TerminalTheme optionalposition: namedpipeline: False: Optional custom palette, normally created by New-ImageConsoleStoryPalette.
Profile String optionalposition: namedpipeline: Falsevalues: 5: Built-in profile that supplies prompt behavior, default working directory, palette, and icon.; Possible values: PowerShell, WindowsPowerShell, Ubuntu, Bash, CommandPrompt
Title String optionalposition: 1pipeline: False: Visible tab title. Defaults to the selected profile name.
TransitionSeconds Double optionalposition: namedpipeline: False: Duration of the visual switch from the previously active tab.
WorkingDirectory String optionalposition: namedpipeline: False: Working directory shown by this tab. Defaults to C:\ for Windows profiles and ~ for POSIX profiles.

Outputs

ImagePlayground.PowerShell.ImageConsoleStoryStep: Use the console story command, output, table, blank-line, pause, tab, and tab-selection cmdlets to create steps.

New-ImageConsoleStoryTab -Active -Id <String> [-Palette <TerminalTheme>] [-Profile <PowerShell|WindowsPowerShell|Ubuntu|Bash|CommandPrompt>] [-Title <String>] [-TransitionSeconds <Double>] [-WorkingDirectory <String>] [<CommonParameters>]

Parameter set: Initial

Parameters

Active SwitchParameter requiredposition: namedpipeline: False: Configure this declaration as the initial active tab. It must be the first content step.
Id String requiredposition: 0pipeline: False: Stable identifier used by later tab-selection steps.
Palette TerminalTheme optionalposition: namedpipeline: False: Optional custom palette, normally created by New-ImageConsoleStoryPalette.
Profile String optionalposition: namedpipeline: Falsevalues: 5: Built-in profile that supplies prompt behavior, default working directory, palette, and icon.; Possible values: PowerShell, WindowsPowerShell, Ubuntu, Bash, CommandPrompt
Title String optionalposition: 1pipeline: False: Visible tab title. Defaults to the selected profile name.
TransitionSeconds Double optionalposition: namedpipeline: False: Duration of the visual switch from the previously active tab.
WorkingDirectory String optionalposition: namedpipeline: False: Working directory shown by this tab. Defaults to C:\ for Windows profiles and ~ for POSIX profiles.

Outputs

ImagePlayground.PowerShell.ImageConsoleStoryStep: Use the console story command, output, table, blank-line, pause, tab, and tab-selection cmdlets to create steps.

New-ImageConsoleStoryTab -Background -Id <String> [-Palette <TerminalTheme>] [-Profile <PowerShell|WindowsPowerShell|Ubuntu|Bash|CommandPrompt>] [-Title <String>] [-TransitionSeconds <Double>] [-WorkingDirectory <String>] [<CommonParameters>]

Parameter set: Background

Parameters

Background SwitchParameter requiredposition: namedpipeline: False: Declare the tab without activating it. Use Select-ImageConsoleStoryTab for the later intentional switch.
Id String requiredposition: 0pipeline: False: Stable identifier used by later tab-selection steps.
Palette TerminalTheme optionalposition: namedpipeline: False: Optional custom palette, normally created by New-ImageConsoleStoryPalette.
Profile String optionalposition: namedpipeline: Falsevalues: 5: Built-in profile that supplies prompt behavior, default working directory, palette, and icon.; Possible values: PowerShell, WindowsPowerShell, Ubuntu, Bash, CommandPrompt
Title String optionalposition: 1pipeline: False: Visible tab title. Defaults to the selected profile name.
TransitionSeconds Double optionalposition: namedpipeline: False: Duration of the visual switch from the previously active tab.
WorkingDirectory String optionalposition: namedpipeline: False: Working directory shown by this tab. Defaults to C:\ for Windows profiles and ~ for POSIX profiles.

Outputs

ImagePlayground.PowerShell.ImageConsoleStoryStep: Use the console story command, output, table, blank-line, pause, tab, and tab-selection cmdlets to create steps.