1.0.4 • Published 4 months ago

jquery-review-gate v1.0.4

Weekly downloads
-
License
MIT
Repository
github
Last release
4 months ago

Review Gate

Inspiration

Contracted to consult on digital strategy to help the client build stronger brand awareness/reputation across various platforms

  • Goal: Build 5-star reviews across various social profiles and/or review sites, such as: Google My Business, Yelp, Facebook Business, etc.
  • Friction Point: Client was hesitant to push reviews to all customers (new or previous) because of possible 1-star reviews
  • Solution: Build a review gate to capture bad reviews and promote 5 star reviews to various platforms
  • Outcome: 1275% increase of 5-star reviews within ~6 months (from 4 to 55). SEO also yielded great results for local searches related to service :)

I published this jQuery plugin because to my surprise there were no quick out of the box solutions that were free. I've used this plugin multiple times for many clients across various industries and saw great results. Hope this helps anyone looking to quickly create a marketing review gate.

Plugin Description

Review gate made with jQuery to capture user reviews that are not 5-star quality. This helps businesses collect both negative and positive feedback to better enhance their customer service experience.

The screenshot(s) below use a fake/pseudo company to illustrate the review gate.

Quick Start

HTML Markup Sample

<nav class="review-gate-navbar" style="display: none">
  <button class="review-gate-navbar__btn">&#10094;</button>
  <div class="review-gate-navbar__logo-wrapper">
    <img
      class="review-gate-navbar__logo"
      src="./img/sample-logo.png"
      alt="logo"
    />
  </div>
</nav>

<main>
  <div id="review-gate">
    <section class="review-step">
      <h2 class="review-title">Rate Your Recent Experience</h2>
    </section>
    <section class="review-step">
      <h2 class="review-title">Please Leave Us A Review!</h2>
      <p>
        We are very happy to hear you had a positive experience with [ex:
        "bluetech"]. Please take a second to leave us a review on [review
        platform]
      </p>
      <a class="btn leave-review-btn" href="#">Leave Review</a>
    </section>
    <section class="review-step">
      <h2 class="review-title">Please Leave Us Some Feedback</h2>
      <p>
        We are sorry to hear you did not have a 5-Star experience. Please take a
        moment to leave us feedback on how we can improve.
        <br />
        <br />
        [Insert Your Feedback Form Here]
      </p>
    </section>
  </div>
</main>

On Document Ready

var config = {
  navbarColor: "#0f18e9",
  onUpdate: function (count) {
    if (count >= 5) {
      // Do something on good review
      $("#review-gate").reviewGate("step", 2);
    } else {
      // Do something on bad review
      $("#review-gate").reviewGate("step", 3);
    }
  },
};

$(document).ready(function () {
  $("#review-gate").reviewGate(config);
});

Default Configs

If you do not specify a config object when you initialize the review gate the following will be used:

var defaults = {
  stepClassName: "review-step",
  navbarColor: "#fff",
  navBarClassName: "review-gate-navbar",
  navBarBackBtnClassName: "review-gate-navbar__btn",
  enableNavBackBtn: true,
  emojiConfig: {
    emoji: "star",
    fontSize: 42,
    attributes: {
      id: "emoji-ratings-wrapper",
      // You can spread additional HTML attributes to your emoji element wrapper.
      // By default, only an ID attribute is used.
    },
    css: {},
  },
  onUpdate: function () {
    alert("Add an onUpdate function");
  },
};
PropertyType
stepClassNameString
navBarColorString
navBarClassNameString
navBarBackBtnClassNameString
enableNavBackBtnBoolean
emojiConfigObject
onUpdateFunction

Installation Methods

Clone the Repo

https://github.com/davidkim10/jquery-review-gate.git

Build Minified Files

npm run build

Load the review gate JS file after jQuery.

<!--Example: JS Dependencies -->
<script src="/path/to/js/jquery.min.js" defer></script>
<script src="/path/to/js/review-gate.jquery.js" defer></script>

NPMJS

Download the NPM package

npm i jquery-review-gate

JSDelivr CDN

Use the JSDelivr CDN links below to upload the JS libraries to your project.

<!-- Load this after jQuery library -->
<!-- Be sure to get the latest version from JSDelivr -->
<script src="https://cdn.jsdelivr.net/npm/jquery-review-gate@1.0.3/dist/js/review-gate.jquery.min.js"></script>

Font Used In Demo

font-family: 'Poppins', sans-serif;

Google Fonts CDN:

<link
  href="https://fonts.googleapis.com/css2?family=Poppins:wght@400;700&display=swap"
  rel="stylesheet"
/>

User Journey

userjourney

Screenshots

screenshot screenshot screenshot screenshot screenshot