Typeform/embed is the core embed library that lets you embed typeforms to your website using vanilla JavaScript.

Requirements:

• node >= 14 (for node v12 use v1.38.0)
• yarn or npm

Install using your favourite package manager:

yarn add @typeform/embed

or

npm install --save @typeform/embed

Import the lib, CSS and create your embed:

import { createWidget } from '@typeform/embed'
import '@typeform/embed/build/css/widget.css'
createWidget('<form-id>', { container: document.querySelector('#form') })

As HTML, the CSS is imported automatically. Place this code where you want to display your form.

<div data-tf-widget="<form-id>"></div>
<script src="//embed.typeform.com/next/embed.js"></script>

Via JavaScript for more control and specific integration.

<button id="button">open form</button>
<script src="//embed.typeform.com/next/embed.js"></script>
<link rel="stylesheet" href="//embed.typeform.com/next/css/popup.css" />
<script>
  const { open, close, toggle, refresh } = window.tf.createPopup('<form-id>')
  document.querySelector('#button').onclick = toggle
</script>

You can find <form-id> from the public URL of your form:

• https://form.typeform.com/to/<form-id>

Or from admin panel URL:

• https://admin.typeform.com/form/<form-id>/*

For security purposes we prevent embedding typeorms in unsecure pages (via CSP headers). You can embed your typeform on pages served over HTTPS or via HTTP on localhost. You can also embed in wrapped progressive web apps.

<div id="form"></div>
<script>
  const { refresh, unmount } = createWidget('<form-id>', {
    container: document.querySelector('#form'),
    ...options,
  })
</script>

The createWidget method returns 2 functions:

• refresh - reloads the form
• unmount - unmounts the form (you should use this when you implement this lib in React manually)

• popup: createPopup('<form-id>', options)
• slider: createSlider('<form-id>', options)
• sidetab: createSidetab('<form-id>', options)
• popover: createPopover('<form-id>', options)

<button id="button">open form</button>
<script>
  const { open, close, toggle, refresh } = createPopup('<form-id>')
  document.querySelector('#button').onclick = toggle
</script>

Each of the create* methods for modal windows return 4 functions:

• open - open the modal window (popup, slider, sidetab or popover) and display the form
• close - close the modal window and hide the form
• toggle - open when closed, close when opened
• refresh - reloads the form
• unmount - unmounts the form (you should use this when you implement this lib in React manually)

Closing and opening a typeform in modal window will restart the progress from the beginning. However answers will be saved in browsers local storage.

options is an object with optional properties:

• to embed via HTML without writing JavaScript code, use data-tf-widget="<form-id>" for widget embed (see example above)
• define options as data attributes with data-tf- prefix and dashes in name (eg. autoFocus becomes data-tf-auto-focus)
• set a boolean property to true by omitting attribute value, (eg. <div ... data-tf-disable-footer></div>
• pass function name for callbacks, eg. data-tf-on-ready="myReadyFunction" if this function is available on global scope (eg. window)
• to pass string[] use comma-separated string, eg. transitiveSearchParams: ['foo', 'bar'] becomes data-tf-transitive-search-params="foo,bar"
• to pass object pass comma-separated key=value pairs, eg. hidden: { foo: "f", bar: "b" } becomes data-tf-hidden="foo=f,bar=b"
  • Note: since commas , are used as delimiter for each value you will need to escape them with backward slash, eg. data-tf-hidden="foo=foo\,bar". In JavaScript you don't need to escape it.

Properties open and openValue apply only to embed types that are opened by user action (all except widget). They define when to automatically open the typeform.

• on page load
  • open: 'load'
  • openValue leave undefined (not used)
• when user tries to leave the page
  • open: 'exit'
  • openValue specify the sensitivity threshold
  • To detect user is trying to exit the page we detect upwards mouse movement in top part of the website. The threshold defines height of this area. Useful when you have navigation in top part of your website and mouse movement in that area does not necessarily indicate exit intent.
• when a user scrolls the page
  • open: 'scroll'
  • openValue percentage of page scrolled (0 - 100) to open the form
• after time elapsed
  • open: 'time'
  • openValue number of milliseconds to wait before opening the form

For details see behavioral demo.

You can use shareGaInstance: true (or data-tf-share-ga-instance) attribute if both your page and your typeform are using Google Analytics. This will make sure the session is shared and Google Analytics will track only 1 user when they visit you page with an embedded typeform.

If you have more than 1 Google Analytics tracking codes in your website you can provide an ID to specify which tracker to use, eg:

<div data-tf-widget="<form-id>" data-tf-share-ga-instance="UA-XXXXXX-XX"></div>

or

createPopup('<form-id>', { container, shareGaInstance: 'UA-XXXXXX-XX' })

You can listen to form events by providing callback methods:

<button id="btn">click</button>
<script src="//embed.typeform.com/next/embed.js"></script>
<link rel="stylesheet" href="//embed.typeform.com/next/css/widget.css" />
<script>
  const { open } = window.tf.createPopup('<form-id>', {
    onReady: ({ formId }) => {
      console.log(`Form ${formId} is ready`)
    },
    onStarted: ({ formId, responseId }) => {
      console.log(`Form ${formId} started with response ID ${responseId}`)
    },
    onQuestionChanged: ({ formId, ref }) => {
      console.log(`Question in form ${formId} changed to ${ref}`)
    },
    onHeightChanged: ({ formId, ref, height }) => {
      console.log(`Question ${ref} in form ${formId} has height ${height}px now`)
    },
    onSubmit: ({ formId, responseId }) => {
      console.log(`Form ${formId} submitted, response id: ${responseId}`)
      // to retrieve the response use `responseId` (you have to do it server-side)
      // more details: https://developer.typeform.com/responses/
    },
    onClose: ({ formId }) => {
      console.log(`Modal window with form ${formId} was closed`)
    }
    onEndingButtonClick: ({ formId, ref }) => {
      console.log(`Ending button clicked in form ${formId}`)

      // for plans with "Redirect from ending screen" feature you also receive `ref`:
      console.log(`Ending button clicked in end screen ${ref}`)
    }
  })
  document.querySelector('#btn').click = () => {
    open()
  }
</script>

Callback method receive payload object from the form. Each payload contains form ID to identify which form sent the event (see chaining typeforms below):

• onReady
  • formId (string)
• onStarted
  • formId (string)
  • responseId (string)
• onQuestionChanged
  • formId (string)
  • ref (string) identifies currently displayed question
• onHeightChanged
  • formId (string)
  • ref (string) identifies currently displayed question
  • height (number) current height of currently displayed question
• onSubmit
  • formId (string)
  • responseId (string) identifies the response, can be retrieved via Responses API
• onClose
  • no payload
• onEndingButtonClick
  • formId (string)
  • ref (string) identifies the end screen (Note: this is available for plans with "Redirect from ending screen" feature only.)

See callbacks example in demo package.

Custom icon provided string supports:

• URL (used as an img src)
• Text and Emojis
• HTML Markup

You can supply a target for typeform redirect (on submit or via ending). It works the same as target for anchor HTML element:

• _parent (default), opens in parent page
• _self opens in the same embedded iframe as your typeform
• _top opens in current browser tab (same as _parent unless there are multiple nested iframes)
• _blank opens in new tab, however it might be blocked by popup blockers.

⚠️ Warning: Target _blank is not working in Safari (both desktop and mobile) and triggers a popup warning in Chrome on Android. It works in Chrome and Firefox on desktop.

If you set target to _self and also enable autoClose option the iframe with your redirect will be closed before users are able to interact with it.

All embeds that are intended to be displayed over existing content in the website have z-index set to 10001. If you want to display content over your typeform you need to make sure it has higher z-index. However if you want your typeform to display over other content in your website you need to set its z-index to a value of 10000 or lower.

This is related to all embeds:

• popup
• slider
• sidetab
• popover
• widget - on mobile devices widget opens in fullscreen modal window (unless inlineOnMobile is set)

You can chain multiple typeforms inside an embed. You need to setup a redirect to another typeform:

• make sure to use URL with typeform.com domain in case you have a custom domain set up
• set redirectTarget / data-tf-redirect-target to _self to make the redirect inside the embed iframe

When you chain multiple typeforms they will be all displayed inside the embed and all embed options and callbacks will be preserved. You can use formId in the callback payload to identify which form is currently displayed.

When the library loads it will initialize all HTML embed codes already present in the page. However sometimes you might want to add HTML snippet to your page later and initialize it after it was added.

To load new snippets use:

window.tf.load()

If you need to reload all snippets in the page:

window.tf.reload()

You can see an example of this in reload-event.html.

You can find examples for specific use-cases in our demos:

• HTML demo
• Webpack demo
• React demo
• Next.js demo
• Codesandbox demo

Fork and clone this Github repo: https://github.com/Typeform/embed

Requirements:

• node >= 16
• yarn

Install dependencies:

yarn

We recommend you work in a branch:

git checkout -b cool-new-feature

Build, watch for changes and start a demo server too (using demo-nextjs)

yarn demo

Build and watch for changes:

yarn dev

Run unit tests:

yarn test

Run functional tests via Cypress:

yarn cy:run   # run in background (headless)
yarn cy:open  # open cypress UI

Run visual tests via Cypress and VRT:

yarn cy:visual    # run in background (headless)
yarn cy:open:vrt  # open cypress UI (with support for VRT)

Note: You need access to our self-hosted Visual Regression Tracker (aka VRT). Copy vrt.example.json to vrt.json and provide apiKey to run visual tests locally.

See details on contributing to this repo.