69 lines
2.1 KiB
JavaScript
69 lines
2.1 KiB
JavaScript
import Highlight from 'react-highlight'
|
|
import ToggleContent from '../../../shared/ToggleContent';
|
|
import DocLink from 'Shared/DocLink/DocLink';
|
|
|
|
const ReduxDoc = (props) => {
|
|
return (
|
|
<div className="p-4">
|
|
<div>This plugin allows you to capture Redux actions/state and inspect them later on while replaying session recordings. This is very useful for understanding and fixing issues.</div>
|
|
|
|
<div className="font-bold my-2 text-lg">Installation</div>
|
|
<Highlight className="js">
|
|
{`npm i @openreplay/tracker-redux --save`}
|
|
</Highlight>
|
|
|
|
|
|
<div className="font-bold my-2 text-lg">Usage</div>
|
|
<p>Initialize the tracker then put the generated middleware into your Redux chain.</p>
|
|
<div className="py-3" />
|
|
<ToggleContent
|
|
label="Is SSR?"
|
|
first={
|
|
<Highlight className="js">
|
|
{`import { applyMiddleware, createStore } from 'redux';
|
|
import OpenReplay from '@openreplay/tracker';
|
|
import trackerRedux from '@openreplay/tracker-redux';
|
|
//...
|
|
const tracker = new OpenReplay({
|
|
projectKey: PROJECT_KEY
|
|
});
|
|
tracker.start();
|
|
//...
|
|
const store = createStore(
|
|
reducer,
|
|
applyMiddleware(tracker.use(trackerRedux(<options>))) // check list of available options below
|
|
);`}
|
|
</Highlight>
|
|
}
|
|
second={
|
|
<Highlight className="js">
|
|
{`import { applyMiddleware, createStore } from 'redux';
|
|
import OpenReplay from '@openreplay/tracker/cjs';
|
|
import trackerRedux from '@openreplay/tracker-redux/cjs';
|
|
//...
|
|
const tracker = new OpenReplay({
|
|
projectKey: PROJECT_KEY
|
|
});
|
|
//...
|
|
function SomeFunctionalComponent() {
|
|
useEffect(() => { // or componentDidMount in case of Class approach
|
|
tracker.start();
|
|
}, [])
|
|
//...
|
|
const store = createStore(
|
|
reducer,
|
|
applyMiddleware(tracker.use(trackerRedux(<options>))) // check list of available options below
|
|
);
|
|
}`}
|
|
</Highlight>
|
|
}
|
|
/>
|
|
|
|
<DocLink className="mt-4" label="Integrate Redux" url="https://docs.openreplay.com/plugins/redux" />
|
|
</div>
|
|
)
|
|
};
|
|
|
|
ReduxDoc.displayName = "ReduxDoc";
|
|
|
|
export default ReduxDoc;
|