Getting Started
Browse through ReachFive UI SDK JS methods.
These methods alter the DOM, so a <div>
must be provided with a specific id
on your webpage.
Browser compatibility
The SDK is compatible with the latest versions of:
-
Edge,
-
Chrome,
-
Firefox,
-
Safari,
-
and IE 11.
Prerequisites
To initialize the ReachFive client:
-
You need a Domain URL and Client ID.
-
You must whitelist all available domains where the ReachFive SDK will be used.
This is done in the Allowed Origins (CORS) field of your ReachFive console, in the Settings menu.
The ReachFive client detects the user locale from the browser. You can override this at initialization by providing a language. Currently, we support:
|
You must have at least version Check this with
|
Installation
-
You can install the latest release of the package via
npm
:npm install --save @reachfive/identity-ui
-
You can also download and include with a script tag from the third-party unpkg CDN:
<script src="https://unpkg.com/@reachfive/identity-ui@x.y.z/umd/identity-ui.min.js"></script>
The SDK registers a
reach5Widgets
global variable in the window object.
Use the createClient
method to initialize a ReachFive client.
import { createClient } from '@reachfive/identity-ui';
const DOMAIN = 'Here paste your ReachFive domain';
const CLIENT_ID = 'Here paste your ReachFive client ID';
const client = createClient({
domain: DOMAIN,
clientId: CLIENT_ID,
// Optional parameter
language: 'Here paste a language code'
});
<script src="https://unpkg.com/@reachfive/identity-ui@x.y.z/umd/identity-ui.min.js"></script> (1)
<script type="text/javascript">
const DOMAIN = 'Here paste your ReachFive domain';
const CLIENT_ID = 'Here paste your ReachFive client ID';
const client = reach5Widgets.createClient({
domain: DOMAIN,
clientId: CLIENT_ID,
// Optional parameter
language: 'Here paste a language code'
});
</script>
1 | Replace x.y.z by the specific version you require. |
All code examples assume the ReachFive client was instantiated and stored in a variable named client
.