Skip to content

Commit

Permalink
feat(TU-17542): Update docs on sandbox mode
Browse files Browse the repository at this point in the history 
Resolves #662
  • Loading branch information
@mathio
mathio committed Aug 30, 2024
1 parent 8e63fc9 commit a0b8110
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 2 deletions.
2 changes: 1 addition & 1 deletion docs/configuration.md
View file
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
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

0 comments on commit a0b8110

Please sign in to comment.