Add ArcxAnalyticxProvider and an example CRA app #21
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
classicus-eth
requested changes
Nov 14, 2022
|
This is because the npm package is not yet published. The way to make it work on this branch is to:
Then try again. The idea however is to publish this package and make the example repo pull the package from npm directly. |
gtupak
commented
Nov 14, 2022
gtupak
force-pushed
the
refactor/do-not-save-url-in-window
branch
from
3c2355e to
922fd39
Compare
add window object typing rm comments and log do not save the url on the window object and add medium option to attribute call make the current url private add arcx analyticx provider and CRA example project log page events track event clicks on console view update readme fix installations add missing peer dependencies ignore webpack config ts to avoid eslint errors update header and favicon support react versions >=16
gtupak
force-pushed
the
feat/add-provider-and-example
branch
from
3fe072e to
2722a6a
Compare
xitronix
reviewed
Nov 16, 2022
xitronix
reviewed
Nov 16, 2022
xitronix
reviewed
Nov 16, 2022
xitronix
reviewed
Nov 16, 2022
package.json
Outdated
Comment on lines
19
to
21
| "@babel/core": "^7.0.0-0", | ||
| "@babel/plugin-syntax-flow": "^7.14.5", | ||
| "@babel/plugin-transform-react-jsx": "^7.14.9", |
There was a problem hiding this comment.
peer dependencies requirement
There was a problem hiding this comment.
eslint-config-react-app
There was a problem hiding this comment.
.. but now I realized we don't use it in this scope, so removed it! :) good catch!
xitronix
reviewed
Nov 16, 2022
| @@ -0,0 +1 @@ | |||
| /// <reference types="react-scripts" /> | |||
There was a problem hiding this comment.
xitronix
reviewed
Nov 16, 2022
xitronix
approved these changes
Nov 16, 2022
classicus-eth
approved these changes
Nov 17, 2022
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The SDK as-is was a bit of a pain to use as users need to make a custom react provider in their react apps. For this reason, I made a utility
ArcxAnalyticsProviderthat does that for you. It requires theapiKeyand can optionally take aconfigobject.The provider initializes the SDK and exposes a hook
useArcxAnalytics()that children of the provider can use.The tests for the provider will be in a subsequent PR because of some configuration changes regarding the test framework and I don't want to make this PR too big.
In addition, I've added an example Create React App showcasing how to use the provider, with a console-like view showing what events have been fired. I tested this app using
yarn link, but once the npm package is updated we'll be able to test it using the official npm package.