Get-HtmlBrowserInteractable
August 3, 2026 ยท View on GitHub
SYNOPSIS
Returns interactive elements from an active browser session.
SYNTAX
Session (Default)
Get-HtmlBrowserInteractable [[-Session] <HtmlBrowserSession>] [-SlowMo <int>] [-Timeout <int>] [-CancellationToken <CancellationToken>] [-IncludeHidden] [-Limit <int>] [-Filter <string>] [<CommonParameters>]
Url
Get-HtmlBrowserInteractable [-Url] <string> [-Browser <HtmlBrowserEngine>] [-ProfilePath <string>] [-Scenario <HtmlBrowserScenario>] [-UserDataDirectory <string>] [-StatePath <string>] [-BrowserChannel <string>] [-Clean] [-Proxy <string>] [-ProxyCredential <pscredential>] [-Visible] [-SlowMo <int>] [-Timeout <int>] [-LoadState <HtmlBrowserLoadState>] [-BlockResourceType <HtmlNetworkResourceType[]>] [-BlockResourcePattern <string[]>] [-CancellationToken <CancellationToken>] [-IncludeHidden] [-Limit <int>] [-Credential <pscredential>] [-Username <string>] [-Password <string>] [-LoginUrl <string>] [-UsernameSelector <string>] [-PasswordSelector <string>] [-SubmitSelector <string>] [-Filter <string>] [<CommonParameters>]
File
Get-HtmlBrowserInteractable [-Path] <string> [-Browser <HtmlBrowserEngine>] [-ProfilePath <string>] [-Scenario <HtmlBrowserScenario>] [-UserDataDirectory <string>] [-StatePath <string>] [-BrowserChannel <string>] [-Clean] [-Proxy <string>] [-ProxyCredential <pscredential>] [-Visible] [-SlowMo <int>] [-Timeout <int>] [-LoadState <HtmlBrowserLoadState>] [-BlockResourceType <HtmlNetworkResourceType[]>] [-BlockResourcePattern <string[]>] [-CancellationToken <CancellationToken>] [-IncludeHidden] [-Limit <int>] [-Filter <string>] [<CommonParameters>]
DESCRIPTION
Returns interactive elements from an active browser session.
EXAMPLES
EXAMPLE 1
Get-HtmlBrowserInteractable -Path 'C:\Path'
PARAMETERS
-BlockResourcePattern
Playwright URL glob patterns to abort before navigation, such as /analytics/.
Type: String[]
Parameter Sets: Url, File
Aliases: None
Possible values:
Required: False
Position: named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-BlockResourceType
Browser resource types to abort before navigation, such as Image, Media, Font, or Stylesheet.
Type: HtmlNetworkResourceType[]
Parameter Sets: Url, File
Aliases: None
Possible values: Document, Stylesheet, Image, Media, Font, Script, TextTrack, XHR, Fetch, EventSource, WebSocket, Manifest, Other
Required: False
Position: named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Browser
Browser engine to use when loading Url or Path.
Type: HtmlBrowserEngine
Parameter Sets: Url, File
Aliases: None
Possible values: Chromium, Firefox, WebKit
Required: False
Position: named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-BrowserChannel
Browser distribution channel, such as chrome, msedge, chromium, chrome-beta, or msedge-dev.
Type: String
Parameter Sets: Url, File
Aliases: None
Possible values:
Required: False
Position: named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-CancellationToken
Token used to cancel the operation.
Type: CancellationToken
Parameter Sets: Session, Url, File
Aliases: None
Possible values:
Required: False
Position: named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Clean
Reinstall browser runtimes when using Url or Path.
Type: SwitchParameter
Parameter Sets: Url, File
Aliases: None
Possible values:
Required: False
Position: named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Credential
Credentials for pages requiring authentication.
Type: PSCredential
Parameter Sets: Url
Aliases: None
Possible values:
Required: False
Position: named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Filter
Optional case-insensitive filter applied to the element text.
Type: String
Parameter Sets: Session, Url, File
Aliases: None
Possible values:
Required: False
Position: named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-IncludeHidden
Include elements hidden from view.
Type: SwitchParameter
Parameter Sets: Session, Url, File
Aliases: None
Possible values:
Required: False
Position: named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Limit
Maximum number of elements to return.
Type: Int32
Parameter Sets: Session, Url, File
Aliases: None
Possible values:
Required: False
Position: named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-LoadState
Initial browser navigation readiness state.
Type: HtmlBrowserLoadState
Parameter Sets: Url, File
Aliases: None
Possible values: Commit, DomContentLoaded, Load, NetworkIdle
Required: False
Position: named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-LoginUrl
URL of a login form.
Type: String
Parameter Sets: Url
Aliases: None
Possible values:
Required: False
Position: named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Password
Basic authentication password.
Type: String
Parameter Sets: Url
Aliases: None
Possible values:
Required: False
Position: named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-PasswordSelector
CSS selector for the password field.
Type: String
Parameter Sets: Url
Aliases: None
Possible values:
Required: False
Position: named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Path
Path to a local HTML file.
Type: String
Parameter Sets: File
Aliases: File
Possible values:
Required: True
Position: 0
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-ProfilePath
Optional browser profile JSON file used as launch defaults.
Type: String
Parameter Sets: Url, File
Aliases: None
Possible values:
Required: False
Position: named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Proxy
Proxy server address used when launching the browser.
Type: String
Parameter Sets: Url, File
Aliases: None
Possible values:
Required: False
Position: named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-ProxyCredential
Credentials used for the Proxy server.
Type: PSCredential
Parameter Sets: Url, File
Aliases: None
Possible values:
Required: False
Position: named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Scenario
Intent-focused browser automation defaults to apply before explicit parameter values.
Type: HtmlBrowserScenario
Parameter Sets: Url, File
Aliases: None
Possible values: Custom, AuditProof, MailboxProof, LoginProtected, SinglePageApp, LowBandwidth, NetworkCapture, DownloadEvidence
Required: False
Position: named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Session
Browser session containing the page.
Type: HtmlBrowserSession
Parameter Sets: Session
Aliases: None
Possible values:
Required: False
Position: 0
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False
-SlowMo
Slow down Playwright actions by the specified milliseconds.
Type: Int32
Parameter Sets: Session, Url, File
Aliases: None
Possible values:
Required: False
Position: named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-StatePath
Playwright storage-state JSON file for cookies and local storage.
Type: String
Parameter Sets: Url, File
Aliases: StorageStatePath
Possible values:
Required: False
Position: named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-SubmitSelector
CSS selector for the submit element.
Type: String
Parameter Sets: Url
Aliases: None
Possible values:
Required: False
Position: named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Timeout
Timeout in milliseconds for browser operations.
Type: Int32
Parameter Sets: Session, Url, File
Aliases: None
Possible values:
Required: False
Position: named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Url
URL of the page to inspect.
Type: String
Parameter Sets: Url
Aliases: None
Possible values:
Required: True
Position: 0
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-UserDataDirectory
Persistent browser user-data directory for cookies, storage, cache, and permissions.
Type: String
Parameter Sets: Url, File
Aliases: None
Possible values:
Required: False
Position: named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Username
Basic authentication username.
Type: String
Parameter Sets: Url
Aliases: None
Possible values:
Required: False
Position: named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-UsernameSelector
CSS selector for the username field.
Type: String
Parameter Sets: Url
Aliases: None
Possible values:
Required: False
Position: named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Visible
Show the browser instead of running headless.
Type: SwitchParameter
Parameter Sets: Url, File
Aliases: None
Possible values:
Required: False
Position: named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
INPUTS
HtmlTinkerX.HtmlBrowserSession
OUTPUTS
HtmlTinkerX.HtmlInteractableInfo
RELATED LINKS
- None