feat(TU-17542): Update docs on sandbox mode

Resolves #662
Typeform · Aug 30, 2024 · e23791e · e23791e
1 parent 8e63fc9
commit e23791e
Show file tree

Hide file tree

Showing 4 changed files with 5 additions and 5 deletions.
diff --git a/docs/configuration.md b/docs/configuration.md
@@ -54,7 +54,7 @@ If you embed via HTML, you need to pass optinos as attributes with `data-tf-` pr
 | open                   | string           | open embed based on user action (see below)                                                                                                                                                                                                                                                            | `undefined`                                                   |
 | openValue              | number           | based on `open` (see below)                                                                                                                                                                                                                                                                            | `undefined`                                                   |
 | preventReopenOnClose   | boolean          | prevent automatically re-opening the typeform                                                                                                                                                                                                                                                          | `false`                                                       |
-| enableSandbox          | boolean          | enable [sandbox mode](https://help.typeform.com/hc/en-us/articles/360029295952) (disables submissions and tracking)                                                                                                                                                                                    | `false`                                                       |
+| enableSandbox          | boolean          | enable [sandbox mode](https://help.typeform.com/hc/en-us/articles/360029295952) (disables submissions and tracking, the `responseId` in callbacks will have value of `"__sandbox"`)                                                                                                                    | `false`                                                       |
 | buttonText             | string           | customize the button text (sidetab only)                                                                                                                                                                                                                                                               | `"Launch me"`                                                 |
 | customIcon             | string           | customize the message icon (popover, sidetab) [more info](#custom-icon)                                                                                                                                                                                                                                | `undefined`                                                   |
 | tooltip                | string           | display tooltip text next to the button (popover only)                                                                                                                                                                                                                                                 | `undefined`                                                   |

diff --git a/packages/embed/README.md b/packages/embed/README.md
@@ -138,7 +138,7 @@ Closing and opening a typeform in modal window will restart the progress from th
 | [open](https://codesandbox.io/s/github/Typeform/embed-demo/tree/main/demo-html/load-js)                                      | string                      | open embed based on user action (see below)                                                                                                                                                                                                                                                            | `undefined`                                                   |
 | [openValue](https://codesandbox.io/s/github/Typeform/embed-demo/tree/main/demo-html/time-js)                                 | number                      | based on `open` (see below)                                                                                                                                                                                                                                                                            | `undefined`                                                   |
 | [preventReopenOnClose](https://codesandbox.io/s/github/Typeform/embed-demo/tree/main/demo-html/prevent-reopen-on-close-html) | boolean                     | prevent automatically re-opening the typeform                                                                                                                                                                                                                                                          | `false`                                                       |
-| [enableSandbox](https://codesandbox.io/s/github/Typeform/embed-demo/tree/main/demo-html/widget-sandbox)                      | boolean                     | enable [sandbox mode](https://help.typeform.com/hc/en-us/articles/360029295952) (disables submissions and tracking)                                                                                                                                                                                    | `false`                                                       |
+| [enableSandbox](https://codesandbox.io/s/github/Typeform/embed-demo/tree/main/demo-html/widget-sandbox)                      | boolean                     | enable [sandbox mode](https://help.typeform.com/hc/en-us/articles/360029295952) (disables submissions and tracking, the `responseId` in callbacks will have value of `"__sandbox"`)                                                                                                                    | `false`                                                       |
 | [buttonText](https://codesandbox.io/s/github/Typeform/embed-demo/tree/main/demo-html/sidetab-js)                             | string                      | customize the button text (sidetab only)                                                                                                                                                                                                                                                               | `"Launch me"`                                                 |
 | [buttonColor](https://codesandbox.io/s/github/Typeform/embed-demo/tree/main/demo-html/sidetab-customized-html)               | string                      | customize the button background color (sidetab only)                                                                                                                                                                                                                                                   | `#3a7685`                                                     |
 | [buttonTextColor](https://codesandbox.io/s/github/Typeform/embed-demo/tree/main/demo-html/sidetab-customized-html)           | string                      | customize the button text color (sidetab only)                                                                                                                                                                                                                                                         | `white` or `black` (based on background color)                |

diff --git a/packages/embed/e2e/spec/functional/widget.cy.ts b/packages/embed/e2e/spec/functional/widget.cy.ts
@@ -55,13 +55,13 @@ function testMobile(path: string, title: string) {
     it('should reset the form when closing it', () => {
       cy.get('iframe').then(($iframe) => {
         const $body = $iframe.contents().find('body')
-        cy.wrap($body).find('[data-qa="start-button"]').click()
+        cy.wrap($body).find('[data-qa="ok-button"]').click()
         cy.get('.tf-v1-widget-close').click()
       })
       cy.wait(1000)
       cy.get('iframe').then(($iframe) => {
         const $body = $iframe.contents().find('body')
-        cy.wrap($body).find('[data-qa="start-button"]').should('exist')
+        cy.wrap($body).find('[data-qa="ok-button"]').should('exist')
       })
     })
   })

diff --git a/packages/embed/e2e/spec/visual/widget.cy.ts b/packages/embed/e2e/spec/visual/widget.cy.ts
@@ -20,7 +20,7 @@ describe('Embed Widget', () => {
       it('Basic Embed Widget - Mobile fullscreen view', () => {
         cy.get('iframe').then(($iframe) => {
           const $body = $iframe.contents().find('body')
-          cy.wrap($body).find('[data-qa="start-button"]').click()
+          cy.wrap($body).find('[data-qa="ok-button"]').click()
         })
         cy.wait(1000)
         cy.vrt('Basic Embed Widget - Mobile fullscreen view')