INT-26 frames (#3089)

* INT-26 frames

* comments

* comments

* vale comments

docs/visual-testing/_partials/_frames.md

@@ -0,0 +1,8 @@
+You can capture screenshots of `<frame>` and `<iframe>` elements as well. To do this, switch to the desired frame before taking the screenshot.
+
+The screenshot will include only the content in the selected frame.
+Any captured DOM elements, ignored regions or clip elements must be specified in the current frame.
+
+:::note
+Frames support is available only for full page screenshots on desktop.
+:::

docs/visual-testing/integrations/csharp.md

@@ -10,6 +10,7 @@ import FullPageLimit from '../_partials/_fullpage-limit.md';
 import SelectiveDiffing from '../_partials/_selective-diffing.md';
 import SelectiveDiffingGlobal from '../_partials/_selective-diffing-global.md';
 import SelectiveDiffingRegion from '../_partials/_selective-diffing-region.md';
+import Frames from '../_partials/_frames.md';
 
 # C#/.Net WebDriver Integration
 
@@ -456,6 +457,21 @@ await VisualClient.VisualCheck("Visible Sale Banner",
     });
 ```
 
+### Frames
+
+<Frames/>
+
+Example:
+
+```csharp
+Driver.SwitchTo().Frame(0);
+await VisualClient.VisualCheck("Frame capture",
+    new VisualCheckOptions()
+    {
+        FullPage = true,
+    });
+```
+
 ## Examples
 
 Two examples are available:

docs/visual-testing/integrations/java.md

@@ -12,6 +12,7 @@ import SelectiveDiffingGlobal from '../_partials/_selective-diffing-global.md';
 import SelectiveDiffingRegion from '../_partials/_selective-diffing-region.md';
 import FullPageLimitation from '../_partials/_fullpage-limitation.md';
 import FullPageDescription from '../_partials/_fullpage-description.md';
+import Frames from '../_partials/_frames.md';
 
 # Java WebDriver Integration
 
@@ -625,6 +626,22 @@ visual.sauceVisualCheck(
         "Visible Sale Banner", new CheckOptions.Builder().withClipElement(element).build());
 ```
 
+### Frames
+
+<Frames/>
+
+Example:
+
+```java
+import com.saucelabs.visual.CheckOptions;
+RemoteWebDriver driver;
+
+driver.switchTo().frame(0);
+CheckOptions options = new CheckOptions();
+options.enableFullPageScreenshots();
+visual.sauceVisualCheck("Frame capture", options);
+```
+
 ## Examples
 
 Two examples are available:

docs/visual-testing/integrations/nightwatch.md

@@ -10,6 +10,7 @@ import EnvironmentVariables from '../_partials/_environment-variables.md';
 import SelectiveDiffing from '../_partials/_selective-diffing.md';
 import SelectiveDiffingGlobal from '../_partials/_selective-diffing-global.md';
 import SelectiveDiffingRegion from '../_partials/_selective-diffing-region.md';
+import Frames from '../_partials/_frames.md';
 
 # Nightwatch Integration
 
@@ -366,6 +367,20 @@ await browser.sauceVisualCheck('Visible Sale Banner', {
 })
 ```
 
+### Frames
+
+<Frames/>
+
+Example:
+
+```ts
+browser
+  .frame(0)
+  .sauceVisualCheck('Frame capture', {
+    fullPage: true
+  })
+```
+
 ### Fail on failures
 
 By default, Sauce Visual will not fail the test if there are any failures during the comparison process. A failure will be logged in the Sauce Labs Visual dashboard, but the test will continue to run.

docs/visual-testing/integrations/python-robot-framework.md

@@ -8,6 +8,7 @@ import FullPageLimit from '../_partials/_fullpage-limit.md';
 import SelectiveDiffing from '../_partials/_selective-diffing.md';
 import SelectiveDiffingGlobal from '../_partials/_selective-diffing-global.md';
 import SelectiveDiffingRegion from '../_partials/_selective-diffing-region.md';
+import Frames from '../_partials/_frames.md';
 
 # Python (Robot Framework) Integration
 
@@ -169,6 +170,18 @@ Example:
 
 ```
 
+### Frames
+
+<Frames/>
+
+Example:
+
+```robot
+Test Name
+    Select Frame    index=0
+    Visual Snapshot    My Snapshot Name    full_page_config=True
+```
+
 ## Environment variables
 
 Below are the environment variables available in the Sauce Visual Python plugin. Keep in mind that the variables defined or overridden in Robot have precedence over these.

docs/visual-testing/integrations/python.md

@@ -7,6 +7,7 @@ import PythonIntro from '../_partials/_python-shared-intro.md';
 import SelectiveDiffing from '../_partials/_selective-diffing.md';
 import FullPageLimit from '../_partials/_fullpage-limit.md';
 import SelectiveDiffingRegion from '../_partials/_selective-diffing-region.md';
+import Frames from '../_partials/_frames.md';
 
 # Python Integration
 
@@ -228,6 +229,27 @@ Example:
     )
 ```
 
+### Frames
+
+<Frames/>
+
+Example:
+
+```python
+frame_element = driver.find_element(By.TAG_NAME, "iframe")
+driver.switch_to.frame(frame_element)
+
+visual_client.create_snapshot_from_webdriver(
+    "Frame capture",
+    driver=driver,
+    full_page_config=FullPageConfig(
+        scrollLimit=10,
+    ),
+)
+```
+
+
+
 ## Environment variables
 
 Below are the environment variables available in the Sauce Visual Python plugin. Keep in mind that the variables defined in code / configuration have precedence over these.

docs/visual-testing/integrations/webdriverio.md

@@ -9,6 +9,7 @@ import EnvironmentVariables from '../_partials/_environment-variables.md';
 import SelectiveDiffing from '../_partials/_selective-diffing.md';
 import SelectiveDiffingGlobal from '../_partials/_selective-diffing-global.md';
 import SelectiveDiffingRegion from '../_partials/_selective-diffing-region.md';
+import Frames from '../_partials/_frames.md';
 
 # WebdriverIO Integration
 
@@ -281,6 +282,19 @@ await browser.sauceVisualCheck('Visible Sale Banner', {
 })
 ```
 
+### Frames
+
+<Frames/>
+
+Example:
+
+```ts
+await browser.switchToFrame(0);
+await browser.sauceVisualCheck('Frame capture', {
+  fullPage: true,
+});
+```
+
 ### Using Baseline Overrides
 
 <BaselineOverridesWDIO />