Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Merged
merged 1 commit into from
Sep 2, 2024
Merged

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

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/configuration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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` |
Expand Down
2 changes: 1 addition & 1 deletion packages/embed/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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) |
Expand Down
4 changes: 2 additions & 2 deletions packages/embed/e2e/spec/functional/widget.cy.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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')
})
})
})
Expand Down
2 changes: 1 addition & 1 deletion packages/embed/e2e/spec/visual/widget.cy.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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')
Expand Down
Loading