@pactsafe/pactsafe-react-sdk

v2.14.0

Published

3 months ago

Ironclad Clickwrap React SDK - SDK for easy Ironclad Clickwrap implementations leveraging the Ironclad JavaScript Library & API

Downloads

171,566

0High
0Medium
0Low

react-component react clickwrap contract browsewrap pactsafe ironclad

Ironclad Clickwrap React SDK

Features

Automatically loads the Ironclad Clickwrap JavaScript Library into your app so all you have to do is call _ps to use the Ironclad Clickwrap JavaScript library.

PSClickWrap Component

Renders a clickwrap group by providing a site access ID and group key
Render clickwrap groups dynamically using a filter to specify template ID's and/or tags
Dynamically add data to contracts by passing in a custom render_data object
Ability to override properties set within the Ironclad Clickwrap App's group configuration such as:
- Clickwrap style using the clickWrapStyle prop
- Signer ID selector using the signerIdSelector prop
- Displaying all contracts using the displayAll prop
- and more! (See more detailed documentation on available PSClickWrap props here)
Ability to hook into events fired by the Snippet using function props (See documentation on PSClickwrap callback props here)

Demo & Examples

Check out a live demo of the PSClickwrap here

PSClickWrap

PSClickCrap

To build the example locally (after cloning this repo from Github), you must first add your Ironclad Clickwrap Site Access ID by creating a .env file in the root directory and add the following contents:

PACTSAFE_ACCESS_ID=<YOUR_PACTSAFE_ACCESS_ID_HERE>

After doing this, you need to create a clickwrap group with the group key example-web-group. In your example clickwrap group, if you want the render data to work properly, create three tokens in a template within the example-web-group group with the API field names to be: user_token_value, another_token_value, and last_token_value.

Some helpful information on creating templates with render data can be found here. (Note: You shouldn't have to write any javascript to get the demo to work! When implementing yourself, the React SDK uses the dynamic and renderData props to handle rendering of dynamic contracts instead of having to make _ps calls.)

After completing these steps, the demo should load as the online example does by running:

npm install
npm start

Then open http://localhost:3000 in a browser.

Installation

The easiest way to use pactsafe-react-sdk is to install it from NPM

npm install @pactsafe/pactsafe-react-sdk --save

You can also directly download the source files from unpkg to link to the source files directly or download the source from Github and build it yourself.

The following can be found in the project's root directory, as well as compiled using npm run build:

A CommonJS build in lib/
An ES modules build in es/ (enabled by default/without configuration using npm install)
UMD development and production builds in /umd

Usage

Using PSClickWrap

In order to use the PSClickWrap, you must specify a signer ID selector that corresponds to the ID of an <input> field on the page that will identify the signer (usually an email field). This ID should then be passed as the signerIdSelector prop to the PSClickWrap component:

import { PSClickWrap } from '@pactsafe/pactsafe-react-sdk'

...

<input type="email" id="userEmail" placeholder="Your Email"/>

<PSClickWrap accessId={"YOUR_PACTSAFE_ACCESS_ID_HERE"} groupKey={"YOUR_GROUP_KEY_HERE"} signerIdSelector={"userEmail"}/>

Replace with YOUR_PACTSAFE_ACCESS_ID_HERE with your Ironclad Clickwrap Site Access ID found here

Replace YOUR_GROUP_KEY_HERE with your group's key found within your Ironclad Clickwrap Group's configuration

Pass in any additional options using props on the PSClickWrap component.

You can hook into events using the triggered event callback props described here: (See documentation on PSClickwrap callback props here).

For Sandboxes and Trial Accounts on the Demo Environment

For accounts at app.demo.pactsafe.com, set the psScriptUrl prop as //vault.demo.pactsafe.io/ps.min.js to point at the Demo environment.

Props

PSClickWrap Props

(Note you may have to scroll to the right to see the default value)

PSClickwrap Triggered Event Callback Props

New in v2.0 of the React SDK we are introducing triggered event props. These props are functions that can be passed in as props and are called in response to events that happen after a user interacts with a PSClickwrap component. These function props correspond to the triggered events that can be also created using the _ps global created by the snippet. For more information on how triggered events work within the PSSnippet and calling them without the props, you can learn about them here. By using function props, the component will interact with the _ps API for you and clean up after itself when the component is destroyed. The demo page contains various callback examples and the corresponding callback events can be observed in the console output.

As a quick example of the usage of these, if you wanted to enable a button on a valid clickwrap event, here is example code to do so using the onValid and onInvalid event props:

import { PSClickWrap } from '@pactsafe/pactsafe-react-sdk'

...

class Example extends React.Component {
    constructor(props){
        super(props);
        this.state = { hasAgreed: false };
    }

    onValid = () => {
        this.setState({ hasAgreed: true });
    }

    onInvalid = () => {
        this.setState({ hasAgreed: false });
    }

    render () {
        return
        <div>
            <input type="email" id="userEmail" placeholder="Your Email"/>

            <PSClickWrap accessId={"YOUR_PACTSAFE_ACCESS_ID_HERE"} groupKey={"YOUR_GROUP_KEY_HERE"} signerIdSelector={"userEmail"} onValid={this.onValid} onInvalid={this.onInvalid}/>

            <button disabled={!this.state.hasAgreed} type="submit">Submit</button>
        </div>
    }
}

If you do not want to use event callback props, the _ps is loaded into the window object for you to access and set event listeners manually. Using the _ps global you should be able to do everything listed in our full documentation on the PS.js library

The list below describes the props names and corresponding Ironclad Clickwrap events:

onAll

_ps event: all

A special event that is triggered when any other event is triggered. The name of the original event is always the first argument passed to the callback function. The rest of the arguments will match whatever arguments were passed to the original event's callback function.

Callback Arguments

onSent

_ps event: sent

Triggered when a send command has been completed successfully.

Callback Arguments

| Name | Type | Description | |:----------------:|:---------------------------------------:|:---------------------------------------------------------------------------------------------------------------------------------------------------:| | event_type | String | The type of action that was sent. Supported values include: 'agreed', 'disagreed', 'displayed', 'visited' and 'updated'. | | parameters | Object | An object containing the contract and group details that were sent. Contains three parameters: 'contracts', 'versions' and 'group'. | | context | Site, BrowsewrapGroup or ClickwrapGroup | The Site or Group object that initiated the send command. | | payload | String | The URL-encoded payload that would have been sent to the Action API. This argument is only present when the prop disable_sending is set to true. |

onRetrieved

_ps event: retrieved

Triggered when a retrieved command has been completed successfully.

Callback Arguments

onSet

_ps event: set

Triggered when a parameter is set. Note: This event will only be triggered for specific parameters. Supported parameters include: signer_id, signer_id_selector, form_selector. Since this is an event listener for site level properties, you should only set this on one clickwrap on the page if multiple are mounted in order to guarantee the function is idempotent, otherwise it will be called once per clickwrap.

Callback Arguments

onSetSignerId

_ps event: set:signer_id

Triggered when the signer_id parameter is set.

Callback Arguments

onValid

_ps event: valid

Triggered when all of the contracts in a Group have been accepted by a signer.

Callback Arguments

onInvalid

_ps event: invalid

Triggered when all of the contracts in a Group are no longer accepted by a signer. This event will be triggered if a signer un-checks a contract on a valid Group.

Callback Arguments

onRendered

_ps event: rendered

Triggered when a Group object has been rendered.

Callback Arguments

onDisplayed

_ps event: displayed

Triggered when a Group object displays a contract.

Callback Arguments

onScrolled

_ps event: scrolled

Triggered when "Force Scroll" has been enabled in your Group Settings (or passed as a prop) and all of the contracts in a Group have been scrolled to the bottom of within a "Scroll" or "Embedded" Group style/layout.

Callback Arguments

onScrolledContract

_ps event: scrolled:contract

Triggered when "Force Scroll" has been enabled in your Group Settings (or passed as a prop) and one of the contracts in a Group has been scrolled to the bottom of a "Scroll" or "Embedded" Group style/layout.

Callback Arguments

onChecked

_ps event: checked

Triggered when any of the ClickwrapGroup checkboxes is checked.

Callback Arguments

onUnchecked

_ps event: unchecked

Triggered when any of the ClickwrapGroup checkboxes is unchecked.

Callback Arguments

onError

_ps event: error

Triggered when a send or retrieve command encounters an error before being sent.

Callback Arguments

Development (`src`, `lib` and the build process)

See CONTRIBUTING.md

License

MIT License

Published

Vulnerabilities

Links

Maintainers

Keywords

Readme

Ironclad Clickwrap React SDK

Features

PSClickWrap Component

Demo & Examples

PSClickWrap

Installation

Usage

Using PSClickWrap

For Sandboxes and Trial Accounts on the Demo Environment

Props

PSClickWrap Props

PSClickwrap Triggered Event Callback Props

onAll

Callback Arguments

onSent

Callback Arguments

onRetrieved

Callback Arguments

onSet

Callback Arguments

onSetSignerId

Callback Arguments

onValid

Callback Arguments

onInvalid

Callback Arguments

onRendered

Callback Arguments

onDisplayed

Callback Arguments

onScrolled

Callback Arguments

onScrolledContract

Callback Arguments

onChecked

Callback Arguments

onUnchecked

Callback Arguments

onError

Callback Arguments

Development (src, lib and the build process)

License

Development (`src`, `lib` and the build process)