* start moving ui to redux tlk * remove unused reducer * changes for gdpr and site types * ui: migrating duck/roles to mobx * ui: drop unreferenced types * ui: drop unreferenced types * ui: move player slice reducer to mobx family * ui: move assignments to issueReportingStore.ts * remove issues store * some fixes after issues store * remove errors reducer, drop old components * finish removing errors reducer * start moving integrations state to mobx * change(ui): funnel duck cleanup * change(ui): custom fields * change(ui): customMetrics cleanup * change(ui): customMetrics cleanup * change(ui): duck/filters minor cleanup * change(ui): duck/filters cleanup * change(ui): duck/customMetrics cleanup and upgrades * fix integrations service, fix babel config to >.25 + not ie * refactoring integrations reducers etc WIP * finish removing integrations state * some fixes for integrated check * start of projects refactoring * move api and "few" files to new project store * new batch for site -> projects * fix setid context * move all critical components, drop site duck * remove all duck/site refs, remove old components * fixup for SessionTags.tsx, remove duck/sources (?) * move session store * init sessionstore outside of context * fix userfilter * replace simple actions for session store * sessions sotre * Rtm temp (#2597) * change(ui): duck/search wip * change(ui): duck/search wip * change(ui): duck/search wip * change(ui): duck/searchLive wip * change(ui): duck/searchLive wip * change(ui): duck/searchLive wip * change(ui): duck/searchLive wip * change(ui): search states * change(ui): search states * change(ui): search states * change(ui): fix savedSearch store * change(ui): fix savedSearch store * some fixes for session connector * change(ui): fix savedSearch store * change(ui): fix searchLive * change(ui): fix searchLive * fixes for session replay * change(ui): bookmark fetch * last components for sessions * add fetchautoplaylist * finish session reducer, remove deleted reducers * change(ui): fix the search fetch * change(ui): fix the search fetch * fix integrations call ctx * ensure ctx for sessionstore * fix(ui): checking for latest sessions path * start removing user reducer * removing user reducer pt2... * finish user store * remove rand log * fix crashes * tinkering workflow file for tracker test * making sure prefetched sessions work properly * fix conflict * fix router redirects during loading --------- Co-authored-by: Shekar Siri <sshekarsiri@gmail.com>
81 lines
3 KiB
JavaScript
81 lines
3 KiB
JavaScript
import { useStore } from "App/mstore";
|
|
import React from 'react';
|
|
import { CodeBlock } from 'UI'
|
|
import ToggleContent from 'Components/shared/ToggleContent';
|
|
import DocLink from 'Shared/DocLink/DocLink';
|
|
import { observer } from 'mobx-react-lite'
|
|
|
|
const ReduxDoc = () => {
|
|
const { integrationsStore, projectsStore } = useStore();
|
|
const sites = projectsStore.list;
|
|
const siteId = integrationsStore.integrations.siteId
|
|
const projectKey = siteId ? sites.find((site) => site.id === siteId)?.projectKey : sites[0]?.projectKey
|
|
|
|
const usage = `import { applyMiddleware, createStore } from 'redux';
|
|
import OpenReplay from '@openreplay/tracker';
|
|
import trackerRedux from '@openreplay/tracker-redux';
|
|
//...
|
|
const tracker = new OpenReplay({
|
|
projectKey: '${projectKey}'
|
|
});
|
|
// .start() returns a promise
|
|
tracker.start().then(sessionData => ... ).catch(e => ... )
|
|
//...
|
|
const store = createStore(
|
|
reducer,
|
|
applyMiddleware(tracker.use(trackerRedux(<options>))) // check list of available options below
|
|
);`
|
|
const usageCjs = `import { applyMiddleware, createStore } from 'redux';
|
|
import OpenReplay from '@openreplay/tracker/cjs';
|
|
import trackerRedux from '@openreplay/tracker-redux/cjs';
|
|
//...
|
|
const tracker = new OpenReplay({
|
|
projectKey: '${projectKey}'
|
|
});
|
|
//...
|
|
function SomeFunctionalComponent() {
|
|
useEffect(() => { // or componentDidMount in case of Class approach
|
|
// .start() returns a promise
|
|
tracker.start().then(sessionData => ... ).catch(e => ... )
|
|
}, [])
|
|
//...
|
|
const store = createStore(
|
|
reducer,
|
|
applyMiddleware(tracker.use(trackerRedux(<options>))) // check list of available options below
|
|
);
|
|
}`
|
|
return (
|
|
<div className="bg-white h-screen overflow-y-auto" style={{ width: '500px' }}>
|
|
<h3 className="p-5 text-2xl">Redux</h3>
|
|
|
|
<div className="p-5">
|
|
<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>
|
|
<CodeBlock code={'npm i @openreplay/tracker-redux --save'} language={'bash'} />
|
|
|
|
<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="Server-Side-Rendered (SSR)?"
|
|
first={
|
|
<CodeBlock language={'js'} code={usage} />
|
|
}
|
|
second={
|
|
<CodeBlock language={'jsx'} code={usageCjs} />
|
|
}
|
|
/>
|
|
|
|
<DocLink className="mt-4" label="Integrate Redux" url="https://docs.openreplay.com/plugins/redux" />
|
|
</div>
|
|
</div>
|
|
);
|
|
};
|
|
|
|
ReduxDoc.displayName = 'ReduxDoc';
|
|
|
|
export default observer(ReduxDoc);
|