📦 Typeform Embed Libraries

This is a monorepo for all embed libraries.

Libraries

Pick a library you want to use:

• React Embed Library if you are building an app in React
• Vanilla JavaScript Embed Library if you are not using React

Support for other libraries coming later. You can help us if you want 😉

⚠️ Important: This library it is not compatible with the previous version of embed lib - version 0. If you need documentation for previous version see old README here.

Requirements

• node >= 14
• yarn or npm

Node version support: We aim to support all currently supported node versions (active or maintenance). Currently, we support and run tests in node versions 14, 16 and 18. Please refer to node release schedule for specific dates on when specific node versions will be discontinued (end-of-life).

Demos

We have demo projects to show how the libraries work:

• HTML
• Webpack
• Next.js

Contribution

Do you need a specific feature in embed library? Do you think others might benefit from it as well? Do you want to create embed library for another library? This is a section for you! We appreciate your help.

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

We recommend you to open an issue first and discuss your proposed change. Then you can submit your changes through a pull request to this repo.

Before you do, make sure your code works on your local machine:

yarn install
yarn build
yarn lint
yarn test
yarn test:functional
yarn test:visual

For details see README for specific library.

Then you can open a new pull request: https://github.com/Typeform/embed/pulls