Project

PSWriteHTML

PSWriteHTML is an open-source PowerShell project with packages, release history, and working documentation.

View on GitHub Releases Get package

Stars 995

Forks 114

Open issues 69

PowerShell Gallery downloads 7,436,513

Release v1.41.0

Language: PowerShell Updated: 2026-04-11

API Reference

Function

New-HTMLNav

Namespace PSWriteHTML

Creates a new HTML navigation menu with customizable options.

Remarks

This function creates a new HTML navigation menu with various customization options such as navigation links, logo, colors, and menu settings.

Examples

Authored help example

EXAMPLE 1


New-HTMLNav -NavigationLinks { 'Home', 'About', 'Services' } -Logo 'logo.png' -LogoLink 'https://example.com' -TopBarBackGroundColor 'blue' -TopBarColor 'white' -LeftMenuBackgroundColor 'black' -LeftMenuColor 'white'

Creates a new HTML navigation menu with specified navigation links and custom logo, colors, and menu settings.

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-HTMLNav [-DisableBackgroundFading] [-DisableClickToClose] [-DisableHamburger] [-DisableNavControls] [-DisableStickyMenubar] [-FixedMenu] [-LeftMenuBackgroundColor <String>] [-LeftMenuColor <String>] [-Logo <String>] [-LogoLink <String>] [-LogoLinkHome] [-MenuWidth <Int32>] [-MenuWidthExtended <Int32>] [-NavigationLinks <ScriptBlock>] [-ResizeContent] [-StartMenuOpen] [-TopBarBackGroundColor <String>] [-TopBarColor <String>] [<CommonParameters>]

Parameter set: All Parameter Sets

Parameters

DisableBackgroundFading SwitchParameter optionalposition: namedpipeline: False: Switch to disable background fading when the side navigation drawer is open.
DisableClickToClose SwitchParameter optionalposition: namedpipeline: False: Switch to disable closing opened items when the user clicks outside of them.
DisableHamburger SwitchParameter optionalposition: namedpipeline: False: Switch to disable the hamburger menu icon.
DisableNavControls SwitchParameter optionalposition: namedpipeline: False: Switch to disable navigation controls for adjusting drawer width and height.
DisableStickyMenubar SwitchParameter optionalposition: namedpipeline: False: Switch to make the menubar static instead of sticky.
FixedMenu SwitchParameter optionalposition: namedpipeline: False: Switch to make the menu fixed.
LeftMenuBackgroundColor String optionalposition: 7pipeline: False: Specifies the background color of the left menu.
LeftMenuColor String optionalposition: 8pipeline: False: Specifies the text color of the left menu.
Logo String optionalposition: 1pipeline: False: Specifies the path to the logo image to be displayed in the menu.
LogoLink String optionalposition: 2pipeline: False: Specifies the URL to link the logo to.
LogoLinkHome SwitchParameter optionalposition: namedpipeline: False: Indicates whether the logo should link to the home page.
MenuWidth Int32 optionalposition: 3pipeline: False: Specifies the width of the menu (default is 270).
MenuWidthExtended Int32 optionalposition: 4pipeline: False: Specifies the extended width of the menu (default is 320).
NavigationLinks ScriptBlock optionalposition: 0pipeline: False: Specifies the script block containing navigation links to be displayed in the menu.
ResizeContent SwitchParameter optionalposition: namedpipeline: False: Switch to enable content resizing.
StartMenuOpen SwitchParameter optionalposition: namedpipeline: False: Switch to determine if the menu should start open.
TopBarBackGroundColor String optionalposition: 5pipeline: False: Specifies the background color of the top bar.
TopBarColor String optionalposition: 6pipeline: False: Specifies the text color of the top bar.