Adds support for waiting for element to be visible

README.md

@@ -116,6 +116,7 @@ The following is a list of available functions in Monocle:
 * Test-MonocleElementCSS
 * Test-MonocleElementVisible
 * Wait-MonocleElement
+* Wait-MonocleElementVisible
 * Wait-MonocleUrl
 * Wait-MonocleUrlDifferent
 * Wait-MonocleValue

examples/google.ps1

@@ -24,6 +24,6 @@ Start-MonocleFlow -Name 'Google Search' -Browser $browser -ScriptBlock {
     Get-MonocleElement -Id 'logo' | Invoke-MonocleElementClick
 
     # ensure we're back home
-    Wait-MonocleElement -Id 'q'
+    Wait-MonocleElement -Id 'q' | Out-Null
 
 } -CloseBrowser

examples/iframes.ps1

@@ -1,7 +1,15 @@
 param(
     [Parameter(Mandatory=$true)]
     [string]
-    $Url
+    $Url,
+
+    [Parameter(Mandatory=$true)]
+    [string]
+    $Postcode,
+
+    [Parameter(Mandatory=$true)]
+    [string]
+    $Address
 )
 
 $path = Split-Path -Parent -Path (Split-Path -Parent -Path $MyInvocation.MyCommand.Path)
@@ -17,10 +25,9 @@ Start-MonocleFlow -Name 'Elements in iFrames' -Browser $browser -ScriptBlock {
     Set-MonocleUrl -Url $Url
 
     Get-MonocleElement -Id 'fillform-frame-1' | Enter-MonocleFrame -ScriptBlock {
-        Get-MonocleElement -Id 'postcode_search' | Set-MonocleElementValue -Value 'NN1 1AA'
+        Get-MonocleElement -Id 'postcode_search' | Set-MonocleElementValue -Value $Postcode
         Get-MonocleElement -Id 'findAddressbtn' | Invoke-MonocleElementClick
+        Get-MonocleElement -Id 'yourAddress' -WaitVisible | Set-MonocleElementValue -Value $Address
     }
 
-    Start-Sleep -Seconds 5
-
 } -CloseBrowser

examples/youtube.ps1

@@ -19,7 +19,7 @@ Start-MonocleFlow -Name 'Load YouTube' -Browser $browser -ScriptBlock {
     #Get-MonocleElement -Id 'search_query' | Set-MonocleElementValue -Value 'Beerus Madness (Extended)'
 
     # Tells the browser to click the search button
-    Wait-MonocleElement -Id 'search-icon-legacy'
+    Wait-MonocleElement -Id 'search-icon-legacy' | Out-Null
     Get-MonocleElement -Id 'search-icon-legacy' | Invoke-MonocleElementClick
 
     # Though all commands sleep when the page is busy, some buttons use javascript

src/Public/Elements.ps1

@@ -34,6 +34,8 @@ function Set-MonocleElementValue
             $select.SelectByText($Value)
         }
         catch {
+            $select | Out-Default
+            $select.Options | Out-Default
             $select.SelectByValue($Value)
         }
     }
@@ -317,10 +319,16 @@ function Wait-MonocleElement
 
         [Parameter()]
         [int]
-        $Timeout = 600
+        $Timeout = 600,
+
+        [switch]
+        $WaitVisible,
+
+        [switch]
+        $All
     )
 
-    Get-MonocleElementInternal `
+    $result = Get-MonocleElementInternal `
         -FilterType $PSCmdlet.ParameterSetName `
         -Id $Id `
         -TagName $TagName `
@@ -329,7 +337,23 @@ function Wait-MonocleElement
         -ElementValue $ElementValue `
         -XPath $XPath `
         -Selector $Selector `
-        -Timeout $Timeout | Out-Null
+        -Timeout $Timeout `
+        -All:$All
+
+    # set the meta id on the element
+    @($result.Element) | ForEach-Object {
+        Set-MonocleElementId -Element $_ -Id $result.Id
+    }
+
+    # wait for the elements to be visible
+    if ($WaitVisible) {
+        @($result.Element) | ForEach-Object {
+            $_ | Wait-MonocleElementVisible | Out-Null
+        }
+    }
+
+    # return the element
+    return $result.Element
 }
 
 function Get-MonocleElement
@@ -365,6 +389,9 @@ function Get-MonocleElement
         [string]
         $Selector,
 
+        [switch]
+        $WaitVisible,
+
         [switch]
         $All
     )
@@ -386,10 +413,49 @@ function Get-MonocleElement
         Set-MonocleElementId -Element $_ -Id $result.Id
     }
 
+    # wait for the elements to be visible
+    if ($WaitVisible) {
+        @($result.Element) | ForEach-Object {
+            $_ | Wait-MonocleElementVisible | Out-Null
+        }
+    }
+
     # return the element
     return $result.Element
 }
 
+function Wait-MonocleElementVisible
+{
+    [CmdletBinding()]
+    param (
+        [Parameter(Mandatory=$true, ValueFromPipeline=$true)]
+        [OpenQA.Selenium.IWebElement]
+        $Element,
+
+        [Parameter()]
+        [int]
+        $Timeout = 30
+    )
+
+    # get the meta id of the element
+    $id = Get-MonocleElementId -Element $Element
+    Write-MonocleHost -Message "Waiting for element to be visible: $($id)"
+
+    # wait for the element to be visible
+    $seconds = 0
+
+    while ($seconds -le $Timeout) {
+        if (($Element | Test-MonocleElementVisible)) {
+            return $Element
+        }
+
+        $seconds++
+        Start-Sleep -Seconds 1
+    }
+
+    throw "Element '$($id)' was not visible after $($Timeout) seconds"
+}
+
 function Measure-MonocleElement
 {
     [CmdletBinding(DefaultParameterSetName='Id')]