Help Viewer Example

[mdgrs-mei]

A function entry example that opens a sub menu to show help contents of available commands.

Start-PSRunFunctionRegistration

<#
.SYNOPSIS
Get-Help for available commands.

.COMPONENT
PSRun(
    Icon = 📕
    Name = Help Viewer)
#>
function global:GetHelp() {
    $actionKeys = @(
        [PowerShellRun.ActionKey]::new('Enter', 'Get help'),
        [PowerShellRun.ActionKey]::new('Shift+Enter', 'View Online')
    )
    $result = Get-Command | ForEach-Object {
        $entry = [PowerShellRun.SelectorEntry]::new()
        $entry.UserData = $_
        $entry.Name = $_.Name
        $entry.Description = "[{0}]`t{1}" -f $_.CommandType, $_.Source
        $entry.PreviewAsyncScript = {
            param ($command)
            $help = Get-Help $command.Name -Full
            if ($help) {
                $help | Out-String
            } else {
                '{0}Help not found.{1}' -f $PSStyle.Formatting.Error, $PSStyle.Reset
            }
        }
        $entry.PreviewAsyncScriptArgumentList = $_
        $entry.ActionKeys = $actionKeys
        $entry
    } | Invoke-PSRunSelectorCustom

    $command = $result.FocusedEntry.UserData
    if ($result.KeyCombination -eq 'Enter') {
        Get-Help $command -Full
    } elseif ($result.KeyCombination -eq 'Shift+Enter') {
        Get-Help $command -Online
    }
}

Stop-PSRunFunctionRegistration

[mdgrs-mei]