Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/Typeform/embed
Library to embed Typeforms in your website
https://github.com/Typeform/embed
product-ui type-library typeform use-production
Last synced: 13 days ago
JSON representation
Library to embed Typeforms in your website
- Host: GitHub
- URL: https://github.com/Typeform/embed
- Owner: Typeform
- License: mit
- Created: 2020-04-03T09:13:44.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2024-09-02T11:13:20.000Z (3 months ago)
- Last Synced: 2024-10-30T00:35:07.212Z (22 days ago)
- Topics: product-ui, type-library, typeform, use-production
- Language: TypeScript
- Homepage: https://typeform.com/developers/embed/
- Size: 5.73 MB
- Stars: 284
- Watchers: 43
- Forks: 125
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Contributing: docs/contributing.md
- License: LICENSE
- Codeowners: CODEOWNERS
Awesome Lists containing this project
README
# 📦 Typeform Embed Libraries
This is a monorepo for all embed libraries.
# Libraries
Pick a library you want to use:
- [React Embed Library](./packages/embed-react) if you are building an app in React
- [Vanilla JavaScript Embed Library](./packages/embed) if you are not using React
Support for other libraries coming later. [You can help us if you want 😉](#contribution)
⚠️ **Important:** This library it is not compatible with the previous version of embed lib - [version 0](https://github.com/Typeform/embed/tree/master). If you need documentation for previous version [see old README here](https://github.com/Typeform/embed/tree/master#readme).
## Requirements
- node >= 18
- 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](https://github.com/nodejs/release#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](./packages/demo-html)
- [Webpack](./packages/demo-webpack)
- [Next.js](./packages/demo-nextjs)
# 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](https://docs.github.com/en/github/getting-started-with-github/fork-a-repo) this Github repo: https://github.com/Typeform/embed
We recommend you to [open an issue first](https://github.com/Typeform/embed/issues) and discuss your proposed change. Then you can submit your changes [through a pull request](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/about-pull-requests) to this repo.
Before you do, make sure your code works on your local machine:
```bash
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