auth0/contact-form

Name: contact-form

Owner: Auth0

Description: Auth0 Contact Form

Created: 2016-07-15 16:39:57.0

Updated: 2018-05-23 13:39:38.0

Pushed: 2018-05-23 13:39:36.0

Homepage:

Size: 393

Language: JavaScript

GitHub Committers

User	Most Recent Commit	# Commits

Other Committers

User	Email	Most Recent Commit	# Commits

README

Auth0 Contact Form

Install

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

Usage

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

Example

index.js

rt 'jquery';
rt 'bootstrap';
rt ContactForm from 'auth0-contact-form';

t metricsLib = window.metricsLib;
t $ = jQuery;
t options = {
FormSuccess(metricsData) {
metricsLib.track('contact-form-success', metricsData);



t contactForm = new ContactForm(options);

btn').click(contactForm.show);

index.styl

ort '../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:

rt 'jquery';
rt 'bootstrap';
rt { handleQueryString } from 'auth0-contact-form';

t options = {
stUrl: 'https://myserver.com/contact'


leQueryString(options);

Development

Run:

clone git@github.com:auth0/contact-form.git
ontact-form
install
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:
mp {patch,minor,major,VERSION}

Then create the changelog for the release, using
the retrieved version by last command:
t changelog --tag <version>

Then, just run:
t add . && git release <version>

Publish to npm
m 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.