Dynamic text replacement of html pages using query strings
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
dist
src
test
.babelrc
.editorconfig
.eslintrc
.gitignore
.travis.yml
CHANGELOG.md
LICENSE
README.md
gulpfile.js
package-lock.json
package.json

README.md

Switch

Travis build status Code Climate Test Coverage Dependency Status devDependency Status

Background

Welcome to the Switch project from fluidic. Use this module to dynamically replace, show and switch text on html pages and change form values using URL location query strings. Boom Shakalaka!

We wanted to bring the functionality of dynamic content replacement which is available on page builder SAAS platforms like Unbounce to our own projects. After finding no good solutions out there we built this tool in-house. At the agency we use it to develop landing pages that relate specifically to EDM or PPC ad segments, allowing us to deliver niche copy that precisely matches our client’s taget audience.

But that’s us… do with it what you will and give us a shout on Twitter @fluidicagency, or throw some stars like a ninja – we’d love to know what you have created!

Installation

You’ll need all the usual tools and goodies… hang on – actually you don’t! There are zero dependencies, no jQuery, no nothing! Woop!!

Simply download switch.min.js from the dist folder and move in to your project, then add to your code:

const fluidicSwitch = require('./switch.js');

or

import fluidicSwitch from './switch.js';

Once that is one you can kick things off with:

fluidicSwitch.init();

Of course you’ll need to ensure the path matches the location that you placed the js file.

You should also include switch.css in your project.

Usage

The module offers the ability to replace short pieces of text, entire html elements or show/hide html elements. Form values may also be dynamically inserted.

Switch Content

Use the class switch-content and attribute data-switch-key to specify the query string that will be used to provide the replacement. For example:

<p class="switch-content" data-switch-key="company">Small Inc.</p>

Appending the query string index.html?company=Biggus%20Incorporated will replace the contents of the p tag with Biggus Incorporated. Sweet.

Switch Audience

Useful for more sweeping and general changes based on an audience or grouping. Similar to the above but the text to alter is defined in the html elements data attribute whilst the variable is defined in the query string. For example:

<btn class="switch-audience" data-audience-consumer="CLAIM YOUR DISCOUNT">GET A FREE WIDGET</btn>

In this example the text in the data attribute replaces that of the html element when the following query string is employed: index.html?audience=consumer

Switch Show/Hide

Use this option if you have larger portions of text or html that you want to show or hide based on a audience or group.

<p class="switch-show" data-audience-audience="professional">Take a vacation, you deserve it.</p>

By now you can probably guess, a query string such as index.html?audience=professional will show the p element, otherwise it's hidden by default.

Applying the switch-hide class works in the same way.

Note that all elements with the switch-show and switch-hide class applied are initially hidden (via switch.css) and the code logic then decides whether to make the element visible based on the audience settings. This may seem unintuitive, but it actually avoids any temporary visibility of elements that should be hidden whilst the plugin loads.

Options

Currently there is only one option, passed in to init, which is the default audience. E.g., in keeping with the examples above the following would set the default audience as professional (without having to define it in the query parameters):

fluidicSwitch.init('professional');

Credits, Kudos & Props