⚠️ Notice

This package has moved and has been updated signficantly. You can find the latest version at @pactsafe/pactsafe-react-sdk

PactSafe React SDK v1.0

Features

• Automatically loads the PactSafe Snippet into your app so all you have to do is call _ps to use the PactSafe library.

PSClickWrap Component:

• Renders a PactSafe ClickWrap group by providing a site access ID and group key
• Ability to render PactSafe ClickWrap groups dynamically using a filter to specify contract ID's and/or tags
• Ability to render a dynamic PactSafe ClickWrap by passing in a custom render_data object
• Ability to override properties set within the PactSafe App's group configuration such as:
  • ClickWrap style using the clickWrapStyle prop
  • Signer ID selector using the signerIDSelector prop
  • Displaying contracts immediately using the displayImmediately prop
  • Displaying all contracts using the displayAll prop
  • and more! (See more detailed documentation on available PSClickWrap props here)

PSBrowseWrap Component:

• Renders a PactSafe BrowseWrap group by providing a site access ID and group key
• Ability to override properties set within the PactSafe App's group configuration such as:
  • Position of BrowseWrap with the position prop
  • Whether the BrowseWrap should always be visible with the alwaysVisible prop
  • and more! (See more detailed documentation on available PSBrowseWrap props here)

Demo & Examples

PSClickWrap:

PSBrowseWrap:

To build the examples locally, run:

npm install
npm start

Then open https://localhost:8000 in a browser.

NOTE: You must access the example over HTTPS, since PactSafe's response API will only respond to hosts serving content over HTTPS.

Installation

The easiest way to use pactsafe-react-sdk is to install it from NPM and include it in your own React build process (using Browserify, Webpack, etc).

npm install pactsafe-react-sdk --save

You can also use the standalone build by including dist/pactsafe-react-sdk.js in your page. If you use this, make sure you have already included React, and it is available as a global variable.

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-react-sdk'
...

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

Replace with YOUR_PACTSAFE_ACCESS_ID_HERE with your PactSafe Site Access ID found here

Replace YOUR_GROUP_KEY_HERE with your group's key found within your PactSafe group's configuration

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

Using PSBrowseWrap

Your PSBrowseWrap component should be placed where you would like your Legal Center link to appear on the page. Pass what you want the link's text to display as using the linkText prop.

import {PSBrowseWrap} from 'pactsafe-react-sdk'
...

Properties

PSClickWrap Properties:

PSBrowseWrap Properties:

Notes

You must run your web app over HTTPS in order to interact with the PactSafe response API (that powers both the PSClickWrap and PSBrowseWrap components)!

Development (src, lib and the build process)

NOTE: The source code for the component is in src. A transpiled CommonJS version (generated with Babel) is available in lib for use with node.js, browserify and webpack. A UMD bundle is also built to dist, which can be included without the need for any build system.

To build, watch and serve the examples (which will also watch the component source), run npm start. If you just want to watch changes to src and rebuild lib, run npm run watch (this is useful if you are working with npm link).

License

Copyright (c) 2017 PactSafe.

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.