From 00ae06d44155a05a918646a03924bf2c26e609d3 Mon Sep 17 00:00:00 2001
From: Pawel Tomaszewski <pawel.tomaszewski@saucelabs.com>
Date: Mon, 17 Feb 2025 15:14:21 +0100
Subject: [PATCH 1/4] INT-26 frames

---
 docs/visual-testing/_partials/_frames.md      |  8 +++++++
 docs/visual-testing/integrations/csharp.md    | 16 ++++++++++++++
 docs/visual-testing/integrations/java.md      | 17 ++++++++++++++
 .../visual-testing/integrations/nightwatch.md | 14 ++++++++++++
 .../integrations/python-robot-framework.md    | 13 +++++++++++
 docs/visual-testing/integrations/python.md    | 22 +++++++++++++++++++
 .../integrations/webdriverio.md               | 14 ++++++++++++
 7 files changed, 104 insertions(+)
 create mode 100644 docs/visual-testing/_partials/_frames.md

diff --git a/docs/visual-testing/_partials/_frames.md b/docs/visual-testing/_partials/_frames.md
new file mode 100644
index 0000000000..67bd905479
--- /dev/null
+++ b/docs/visual-testing/_partials/_frames.md
@@ -0,0 +1,8 @@
+You can capture screenshots of `<frame>` and `<iframe>` elements as well. To do this, simply switch to the desired frame before taking the screenshot.
+
+The screenshot will include only the content within the selected frame.
+Any captured DOM elements, ignored regions or clip elements must be specified within the current frame.
+
+:::note
+Frames support is available only for full page screenshots on desktop
+:::
diff --git a/docs/visual-testing/integrations/csharp.md b/docs/visual-testing/integrations/csharp.md
index 4680730784..95d68fb8bf 100644
--- a/docs/visual-testing/integrations/csharp.md
+++ b/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:
diff --git a/docs/visual-testing/integrations/java.md b/docs/visual-testing/integrations/java.md
index c75dd6eeae..66b1c8c932 100644
--- a/docs/visual-testing/integrations/java.md
+++ b/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:
diff --git a/docs/visual-testing/integrations/nightwatch.md b/docs/visual-testing/integrations/nightwatch.md
index dc3812e688..e91092b283 100644
--- a/docs/visual-testing/integrations/nightwatch.md
+++ b/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,19 @@ await browser.sauceVisualCheck('Visible Sale Banner', {
 })
 ```
 
+### Frames
+
+<Frames/>
+
+```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.
diff --git a/docs/visual-testing/integrations/python-robot-framework.md b/docs/visual-testing/integrations/python-robot-framework.md
index 793832756d..262a6ed3fa 100644
--- a/docs/visual-testing/integrations/python-robot-framework.md
+++ b/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.
diff --git a/docs/visual-testing/integrations/python.md b/docs/visual-testing/integrations/python.md
index 741407ba69..b2336c730c 100644
--- a/docs/visual-testing/integrations/python.md
+++ b/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.
diff --git a/docs/visual-testing/integrations/webdriverio.md b/docs/visual-testing/integrations/webdriverio.md
index 22cc66e8e9..42ff7ed7b4 100644
--- a/docs/visual-testing/integrations/webdriverio.md
+++ b/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 />

From 63896f3c5dc546bcd44f47ac2857c863180e6d40 Mon Sep 17 00:00:00 2001
From: Pawel Tomaszewski <pawel.tomaszewski@saucelabs.com>
Date: Wed, 19 Feb 2025 13:08:55 +0100
Subject: [PATCH 2/4] comments

---
 docs/visual-testing/_partials/_frames.md       | 2 +-
 docs/visual-testing/integrations/nightwatch.md | 2 ++
 2 files changed, 3 insertions(+), 1 deletion(-)

diff --git a/docs/visual-testing/_partials/_frames.md b/docs/visual-testing/_partials/_frames.md
index 67bd905479..642da20531 100644
--- a/docs/visual-testing/_partials/_frames.md
+++ b/docs/visual-testing/_partials/_frames.md
@@ -4,5 +4,5 @@ The screenshot will include only the content within the selected frame.
 Any captured DOM elements, ignored regions or clip elements must be specified within the current frame.
 
 :::note
-Frames support is available only for full page screenshots on desktop
+Frames support is available only for full page screenshots on desktop.
 :::
diff --git a/docs/visual-testing/integrations/nightwatch.md b/docs/visual-testing/integrations/nightwatch.md
index e91092b283..b7c4165933 100644
--- a/docs/visual-testing/integrations/nightwatch.md
+++ b/docs/visual-testing/integrations/nightwatch.md
@@ -371,6 +371,8 @@ await browser.sauceVisualCheck('Visible Sale Banner', {
 
 <Frames/>
 
+Example:
+
 ```ts
 
 browser

From e27499de4112e397c7e419eca265385faf80229a Mon Sep 17 00:00:00 2001
From: Pawel Tomaszewski <pawel.tomaszewski@saucelabs.com>
Date: Wed, 19 Feb 2025 15:45:52 +0100
Subject: [PATCH 3/4] comments

---
 docs/visual-testing/integrations/nightwatch.md | 1 -
 1 file changed, 1 deletion(-)

diff --git a/docs/visual-testing/integrations/nightwatch.md b/docs/visual-testing/integrations/nightwatch.md
index b7c4165933..25917d037a 100644
--- a/docs/visual-testing/integrations/nightwatch.md
+++ b/docs/visual-testing/integrations/nightwatch.md
@@ -374,7 +374,6 @@ await browser.sauceVisualCheck('Visible Sale Banner', {
 Example:
 
 ```ts
-
 browser
   .frame(0)
   .sauceVisualCheck('Frame capture', {

From 66e22ff759d18ff19728901bc1334f66fdb2ddeb Mon Sep 17 00:00:00 2001
From: Pawel Tomaszewski <pawel.tomaszewski@saucelabs.com>
Date: Thu, 20 Feb 2025 10:42:23 +0100
Subject: [PATCH 4/4] vale comments

---
 docs/visual-testing/_partials/_frames.md                   | 6 +++---
 docs/visual-testing/integrations/python-robot-framework.md | 2 +-
 2 files changed, 4 insertions(+), 4 deletions(-)

diff --git a/docs/visual-testing/_partials/_frames.md b/docs/visual-testing/_partials/_frames.md
index 642da20531..7c3e16f6c9 100644
--- a/docs/visual-testing/_partials/_frames.md
+++ b/docs/visual-testing/_partials/_frames.md
@@ -1,7 +1,7 @@
-You can capture screenshots of `<frame>` and `<iframe>` elements as well. To do this, simply switch to the desired frame before taking the screenshot.
+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 within the selected frame.
-Any captured DOM elements, ignored regions or clip elements must be specified within the current frame.
+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.
diff --git a/docs/visual-testing/integrations/python-robot-framework.md b/docs/visual-testing/integrations/python-robot-framework.md
index 262a6ed3fa..4f7201e521 100644
--- a/docs/visual-testing/integrations/python-robot-framework.md
+++ b/docs/visual-testing/integrations/python-robot-framework.md
@@ -178,7 +178,7 @@ Example:
 
 ```robot
 Test Name
-    Select Frame    index=0    
+    Select Frame    index=0
     Visual Snapshot    My Snapshot Name    full_page_config=True
 ```