React wrapper for CUI renderer
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
demo
public
src
.babelrc
.gitignore
.travis.yml
README.md
commitlint.config.js
package.json
yarn.lock

README.md

React CUI

React wrapper for CUI Typeform render.

What the h*ll is this?

CUI screenshot

At Typeform, we created a new (and we hope) useful way to render your forms, in a more conversational way.

And this is it. If you're not part of our Alpha test yet, join us!

Installation

  1. Add the script yarn add react-cui or npm install --save react-cui
  2. Import it
import Cui from 'react-cui'

<Cui uid='abc123' />

Reference

  • uid {string} - Typeform form ID
  • height {number,string} - The height of the embed after the conversation starts
  • avatar {string} - url of the avatar for the conversation
  • theme {string} - color of the main theme color for the embed, access any type of color format

Events API

  • cui:init with the payload: { uid }
  • cui:reply with the payload: { answer }
  • cui:completed with the payload: { answers }

Example

<div class="cui-embed" id="cui-event" data-cui-uid="abcdfe"></div>
const embedElement = document.getElementById('cui-event')
embedElement.addEventListener('cui:reply', function (e) {
  console.log('reply event', e.detail)
})