Getwaitlist-alpha NPM

React Component for Waitlist (getwaitlist.com)

Documentation

Official docs: https://waitlist.stoplight.io/

Installation

npm install waitlistapi

yarn add waitlistapi

Usage

import React from 'react'
import { Waitlist } from 'waitlistapi'

const App = () => {
  return (
    <div>
      <Waitlist api_key="EXAMPLE" waitlist_link="https://example.com" />
    </div>
  )
}

Required Props

Prop	Type	Default	Definition
api_key	string	`required`	The Waitlist API key found in your dashboard at getwaitlist.com
waitlist_link	URL	`required`	The URL where your waitlist is hosted. Your referral codes will be appended to this URL.

Optional Props

The following interface text is defaulted in code, but you can change them:

Prop	Type	Default	Definition
checkStatusButton	string	`Check status`	Main button text shown in the "check status" view.
checkStatusHeading	string	`Check your status`	Heading text shown in the "check status" view.
joinWaitlistButton	string	`Join waitlist`	Main button text shown in the "join waitlist" view.
joinWaitlistHeading	string	`Get early access`	Heading text shown in the "join waitlist" view (default).
notOnWaitlistHeading	string	`You are not on the Waitlist yet...`	Heading text shown in the "checked status" view (default).
switchToCheckStatusLink	string	`Signed up before? Check your status`	Link shown below the main button to switch views.
switchToJoinWaitlistLink	string	`Not on the waitlist yet? Join today`	Link shown below the main button to switch views.

The following props are all set by the Widget, or are pulled in by API. You should never need to use them, but for completion, here they are:

Prop	Type	Example	Definition
buttonBGColor	string	`#CC00CC`	Background color for the main button. Retrieved from the API.
widgetBackgroundColor	string	`#FFFF00`	Background color for the entire widget. Retrieved from the API.
widgetFontColor	string	`#000000`	Main font color for the entire widget. Retrieved from the API.
platform	string	`wix`	Currently only set for wix integrations.