Skip to content

Add loadEventCallback #90

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Add loadEventCallback #90

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
cd3bc30
Add loadEventCallback
jasonabrown Apr 26, 2024
edb32e7
Updated naming convention to onLoadCallback
jasonabrown Apr 26, 2024
55216c1
Update README.md
jasonabrown Apr 26, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 15 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -124,6 +124,7 @@ For accounts at `app.demo.pactsafe.com`, set the `psScriptUrl` prop as `//vault.
| `snapshotLocation` | Ironclad Clickwrap Snapshot Location Key, this is found within the Snapshot Location configuration | string | No | undefined |
| `testMode` | Enable this to register any contract acceptances as test data that can be cleared within the Ironclad Clickwrap UI | bool | No | false |
| `allowDisagreed` | Enable this to allow invalid events to be triggered when a signer unchecks a checkbox. | bool | Required to be true if `onInvalid` is passed | Value specified in Ironclad Clickwrap Group's UI |
| `onLoadCallback` | See [onLoadCallback](#onLoadCallback) below | function | No | undefined |
| `onAll` | See [onAll](#onAll) below | function | No | undefined |
| `onSent` | See [onSent](#onSent) below | function | No | undefined |
| `onRetrieved` | See [onRetrieved](#onRetrieved) below | function | No | undefined |
Expand Down Expand Up @@ -182,11 +183,24 @@ If you do not want to use event callback props, the `_ps` is loaded into the win

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

## <a name="onLoadCallback"></a> onLoadCallback

_ps event: n/a

A callback that can be added specifically for the load event which is not included in the default set of events below. The first argument is an object containing an error if detected and null otherwise. The remaining arguments will match the arguments were passed to the original event's callback function.

### Callback Arguments

| Name | Type | Description |
|:----------------:|:------------------:|:---------------------------------------------------------------------------------------------------------------------------------------------------:|
| err | Object | An object containing the error if detected; null otherwise. |
|[arguments] | Array<Any> | The arguments passed to the original load event. |

## <a name="onAll"></a> 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.
A special event that is triggered when any event below is triggered (note that this does not include the onLoadCallback event). 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

Expand Down
3 changes: 3 additions & 0 deletions src/PSClickWrap.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -220,6 +220,7 @@ class PSClickWrap extends React.Component {
signerIdSelector,
snapshotLocation,
allowDisagreed,
onLoadCallback,
} = this.props;
const options = {
...(allowDisagreed !== undefined && { allow_disagreed: allowDisagreed }),
Expand Down Expand Up @@ -255,6 +256,7 @@ class PSClickWrap extends React.Component {
if (!isDynamic) group.render();
this.registerEventListeners(key);
}
onLoadCallback && onLoadCallback(err, group);
};

if (customData) {
Expand Down Expand Up @@ -334,6 +336,7 @@ PSClickWrap.propTypes = {
(props) => props.hasOwnProperty('onInvalid'),
PSClickWrap.MUST_SET_ALLOW_DISAGREED,
),
onLoadCallback: PropTypes.func,
debug: PropTypes.bool,
onAll: PropTypes.func,
onSent: PropTypes.func,
Expand Down