@evaluar/typeform-embed

🛠 Typeform Vanilla Embed Library

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

Installation

As NPM package

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') })

From CDN

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>

How to get form id of your form?

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>/*

Limitations

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.

Configuration

Embed types

Widget

<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)

Modal windows: popup, slider, sidetab, popover

• 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

options is an object with optional properties:

name	type	description	default
container	HTMLElement	specify element to place the embed into, only for widget, required	current element when embedding as HTML, otherwise undefined
chat	boolean	embed the typeform as Chat UI	false
position	string	slider position: right or left	right
size	number	size of the popup in percentage	100 (100% size, fullscreen popup)
width	number	width of the embed in pixels (for popup you can specify size instead)	undefined
height	number	height of the embed in pixels, supported by all embeds except slider (for popup you can specify size instead)	undefined
hidden	object	hidden fields to be passed to the form in URL hash	undefined
tracking	object	tracking parameters to be passed to the form in URL query string	undefined
source	string	domain name of the site using the SDK	domain name from window.location
medium	string	name of the plugin built on top of the SDK	"embed-sdk"
mediumVersion	string	version of the plugin built on top of the SDK	"next"
transitiveSearchParams	string[]	search parameters to be forwarded from host page to form	undefined
hideFooter	boolean	hide form progress bar and navigation buttons (does not apply to Chat UI)	false
hideHeaders	boolean	hide header that appears when you have a question group, or a long question (does not apply to Chat UI)	false
opacity	number	form background opacity, number from 0 (fully transparent) 100 (fully opaque)	100
disableAutoFocus	boolean	disable form auto focus when loaded	false
open	string	open embed based on user action (see below)	undefined
openValue	number	based on open (see below)	undefined
enableSandbox	boolean	enable sandbox mode (disables submissions and tracking)	false
buttonText	string	customize the button text (sidetab only)	"Launch me"
customIcon	string	customize the message icon (popover, sidetab) )	undefined
tooltip	string	display tooltip text next to the button (popover only)	undefined
notificationDays	number	display red notification dot, hide for given number of days since popover is open (popover only)	undefined
autoClose	number / boolean	time (ms) until the embedded typeform will automatically close after a respondent clicks the Submit button. (all embeds except widget)	undefined
onReady	function	fires when the form is loaded	undefined
onSubmit	function	fires when user submits the form	undefined
onClose	function	fires when the form is closed (when opened in modal window)	undefined
onQuestionChanged	function	fires when user navigates between form questions	undefined
shareGaInstance	string / boolean	shares Google Analytics instance of the host page with embedded typeform, you can provide your Google Analytics ID to specify which instance to share (if you have more than one in your page)	false
inlineOnMobile	boolean	removes placeholder welcome screen in mobile and makes form show inline instead of fullscreen	false
iframeProps	object	HTML attributes to be passed directly to the iframe with typeform	undefined
lazy	boolean	enable lazy loading (for widget only), typeform starts loading when user scrolls to it, see demo	false
keepSession	boolean	preserve form state when modal window is closed (and re-opened)	false

Options in plain HTML embed

• 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. disableAutoFocus becomes data-tf-disable-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.

Custom Launch Options

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.

Share Google Analytics Instance

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' })

Callbacks

You can listen to form events by providing callback methods:

<div id="wrapper"></div>
<script src="//embed.typeform.com/next/embed.js"></script>
<link rel="stylesheet" href="//embed.typeform.com/next/css/widget.css" />
<script>
  window.tf.createWidget('<form-id>', {
    container: document.getElementById('wrapper'),
    onReady: () => {
      console.log('form ready')
    },
    onQuestionChanged: (data) => {
      console.log('question changed to ref:', data.ref)
    },
    onSubmit: (data) => {
      console.log('forms submitted with id:', data.responseId)
      // to retrieve the response use `data.responseId` (you have to do it server-side)
      // more details: https://developer.typeform.com/responses/
    },
  })
</script>

Callback method receive payload object from the form:

• onReady
  • empty object
• onQuestionChanged
  • ref (string) identifies currenttly displayed question
• onSubmit
  • responseId (string) identifies the response, can be retrieved via Responses API
  • response_id (string) same as above (for backward compatibility with old embed SDK)
• onClose
  • no payload

See callbacks example in demo package.

Positioning and overlapping

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)

Loading and reloading embedded forms

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.

Examples

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

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

Local setup and development

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

Requirements:

• node >= 12
• yarn

Install dependencies:

yarn

We recommend you work in a branch:

git checkout -b cool-new-feature

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

See details on contributing to this repo.