Miss any of our Open RFC calls?Watch the recordings here! »

auth0-contact-form

2.0.18 • Public • Published

Auth0 Contact Form

screen shot 2016-07-18 at 2 32 33 pm

Install

npm i --save auth0-contact-form jquery@2 bootstrap@3

Usage

Needs jQuery and bootstrap.js, because they are peer dependencies.

Example

index.js

import 'jquery';
import 'bootstrap';
import ContactForm from 'auth0-contact-form';
 
const metricsLib = window.metricsLib;
const $ = jQuery;
const options = {
  onFormSuccess(metricsData) {
    metricsLib.track('contact-form-success', metricsData);
  }
};
 
const contactForm = new ContactForm(options);
 
$('.btn').click(contactForm.show);

index.styl

@import '../node_modules/auth0-contact-form/build/contact-form.css'

Options

Option Type Default Description
onModalOpen function () => {} On modal open callback, has metricsData arg with metrics data.
onFormSuccess function () => {} On form success callback, has metricsData arg with metrics data.
onFormFail function () => {} On form fail callback, has metricsData arg with metrics data.
postUrl string 'https://webtask.it.auth0.com/api/run/auth0-generic/contact-form-mandrill' Url to send post data of form.
modalTitle string 'Contact Sales Team' Modal title.

Methods

Method Argument Description
show Shows contact form modal

Handle query string

Also this package exports a function handleQueryString that triggers the contact form if ?contact=true is on the url.

Example:

import 'jquery';
import 'bootstrap';
import { handleQueryString } from 'auth0-contact-form';
 
const options = {
  postUrl: 'https://myserver.com/contact'
};
 
handleQueryString(options);

Development

Run:

git clone git@github.com:auth0/contact-form.git
cd contact-form
npm install
npm start

And point your browser at http://localhost:3001.

Release

Make sure you have bump and git-extras Follow the next steps:

  # Once finished your changes and commit them, run: 
  bump {patch,minor,major,VERSION}
 
  # Then create the changelog for the release, using 
  # the retrieved version by last command: 
  git changelog --tag <version>
 
  # Then, just run: 
  git add . && git release <version>
 
  # Publish to npm 
  npm publish
 
  # Done! 

Issue Reporting

If you have found a bug or if you have a feature request, please report them at this repository issues section. Please do not report security vulnerabilities on the public GitHub issue tracker. The Responsible Disclosure Program details the procedure for disclosing security issues.

License

Auth0 Web Header is MIT licensed.

Install

npm i auth0-contact-form

DownloadsWeekly Downloads

1,666

Version

2.0.18

License

MIT

Unpacked Size

1.61 MB

Total Files

12

Last publish

Collaborators

  • avatar
  • avatar
  • avatar
  • avatar