A React wrapper for [Typeform Embed SDK](https://developer.typeform.com/embed/).
npm install react-typeform-embedA React wrapper for Typeform Embed SDK.
Important: Please be aware that if you are updating this package from a version previous to v.1.0 you will need to apply changes in your implementation.
First install the package
``bash`
yarn add react-typeform-embed
There are five different embed types that you can import as components.
- Widget
- Popup
- Slider
- Sidetab
- Popover
With the widget embed type you can embed your form inline, in a DOM element.
`js
import { Widget } from 'react-typeform-embed';
const App = () => {
render() {
return
}
}
`
With the popup and slider embed types you can embed the form in a modal. You need to pass as children the element/s that will open the modal when clicked.
`js
import { Popup / or Slider / } from 'react-typeform-embed';
const App = () => {
return (
);
}
`
These other modal embed types work exactly as the Popup component but, since they are already visible and clickable, passing children element/s is optional.
`js
import { Sidetab / or Popover / } from 'react-typeform-embed';
const App = () => {
return
}
`
See the source for more examples.
You need to provide the form id as id prop.
You can get the id from the public URL of your form URL (https://form.typeform.com/to/) or admin panel URL (https://admin.typeform.com/form/).
You can also use any other option and callback from the official SDK passing them as props. Find more info here:
- Available Options
- Callback Functions
`js`
height={400}
opacity={80}
hidden={{
userId: 'hidden-user-id'
}}
onSubmit={() => {
console.log('Form submitted!')
}}
hideHeaders
disableAutoFocus
enableSandbox
/>
See a live demo, or run:
`bash``
git clone https://github.com/alexgarces/react-typeform-embed
cd react-typeform-embed
yarn
yarn start
open http://localhost:3000
- Official Typeform React Embed Library
Code released under the MIT license.