Invoke-HtmlBrowserClick

August 3, 2026 ยท View on GitHub

SYNOPSIS

Clicks a selector or visible text target in a browser session before extraction.

SYNTAX

BySelector (Default)

Invoke-HtmlBrowserClick [[-Session] <HtmlBrowserSession>] [-Selector] <string> [-Button <MouseButton>] [-ClickCount <int>] [-Nth <Int32>] [-Modifier <KeyboardModifier[]>] [-IfVisible] [-Timeout <int>] [-PassThru] [-OnFailureEvidence] [-FailureEvidenceFolder <string>] [<CommonParameters>]

ByText

Invoke-HtmlBrowserClick [[-Session] <HtmlBrowserSession>] [-Text] <string> [-Exact] [-Regex <string>] [-Nth <Int32>] [-IfVisible] [-Timeout <int>] [-PassThru] [-OnFailureEvidence] [-FailureEvidenceFolder <string>] [<CommonParameters>]

DESCRIPTION

Clicks a selector or visible text target in a browser session before extraction.

EXAMPLES

EXAMPLE 1

$session = Start-HtmlBrowserSession -Url https://example.org/app
Invoke-HtmlBrowserClick -Session $session -Selector '#loadMore'
Wait-HtmlBrowserContent -Session $session -Text 'More results' -Selector 'main'

EXAMPLE 2

$session = Start-HtmlBrowserSession -Url https://example.org/app
Invoke-HtmlBrowserClick -Session $session -Text 'Accept' -IfVisible

PARAMETERS

-Button

Mouse button to use.

Type: MouseButton
Parameter Sets: BySelector
Aliases: None
Possible values: Left, Right, Middle

Required: False
Position: named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-ClickCount

Number of clicks.

Type: Int32
Parameter Sets: BySelector
Aliases: None
Possible values:

Required: False
Position: named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Exact

Use exact text match.

Type: SwitchParameter
Parameter Sets: ByText
Aliases: None
Possible values:

Required: False
Position: named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-FailureEvidenceFolder

Root folder where failure evidence is written when OnFailureEvidence is used.

Type: String
Parameter Sets: BySelector, ByText
Aliases: None
Possible values:

Required: False
Position: named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-IfVisible

Return without error when the target is absent, hidden, or times out.

Type: SwitchParameter
Parameter Sets: BySelector, ByText
Aliases: None
Possible values:

Required: False
Position: named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Modifier

Keyboard modifiers.

Type: KeyboardModifier[]
Parameter Sets: BySelector
Aliases: None
Possible values: Alt, Control, ControlOrMeta, Meta, Shift

Required: False
Position: named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Nth

Zero-based index of the matching selector or text target to click.

Type: Int32
Parameter Sets: BySelector, ByText
Aliases: None
Possible values:

Required: False
Position: named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-OnFailureEvidence

Export screenshots, HTML, text, Markdown, network summary, and failure context if the click fails.

Type: SwitchParameter
Parameter Sets: BySelector, ByText
Aliases: None
Possible values:

Required: False
Position: named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-PassThru

Return the session object.

Type: SwitchParameter
Parameter Sets: BySelector, ByText
Aliases: None
Possible values:

Required: False
Position: named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Regex

Regular expression for text match.

Type: String
Parameter Sets: ByText
Aliases: None
Possible values:

Required: False
Position: named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Selector

CSS selector of the element to click.

Type: String
Parameter Sets: BySelector
Aliases: None
Possible values:

Required: True
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Session

Existing browser session.

Type: HtmlBrowserSession
Parameter Sets: BySelector, ByText
Aliases: None
Possible values:

Required: False
Position: 0
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-Text

Visible text of the element to click.

Type: String
Parameter Sets: ByText
Aliases: None
Possible values:

Required: True
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Timeout

Timeout in milliseconds.

Type: Int32
Parameter Sets: BySelector, ByText
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.HtmlBrowserSession
  • None