a71381da40
* 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>
74 lines
2.8 KiB
JavaScript
74 lines
2.8 KiB
JavaScript
import React from 'react';
|
|
import ToggleContent from 'Shared/ToggleContent';
|
|
import DocLink from 'Shared/DocLink/DocLink';
|
|
import { CodeBlock } from "UI";
|
|
import { useStore } from 'App/mstore';
|
|
import { observer } from 'mobx-react-lite';
|
|
|
|
const MobxDoc = () => {
|
|
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 mobxUsage = `import OpenReplay from '@openreplay/tracker';
|
|
import trackerMobX from '@openreplay/tracker-mobx';
|
|
//...
|
|
const tracker = new OpenReplay({
|
|
projectKey: '${projectKey}'
|
|
});
|
|
tracker.use(trackerMobX(<options>)); // check list of available options below
|
|
// .start() returns a promise
|
|
tracker.start().then(sessionData => ... ).catch(e => ... );
|
|
`
|
|
|
|
const mobxUsageCjs = `import OpenReplay from '@openreplay/tracker/cjs';
|
|
import trackerMobX from '@openreplay/tracker-mobx/cjs';
|
|
//...
|
|
const tracker = new OpenReplay({
|
|
projectKey: '${projectKey}'
|
|
});
|
|
tracker.use(trackerMobX(<options>)); // check list of available options below
|
|
//...
|
|
function SomeFunctionalComponent() {
|
|
useEffect(() => { // or componentDidMount in case of Class approach
|
|
// .start() returns a promise
|
|
tracker.start().then(sessionData => ... ).catch(e => ... )
|
|
}, [])
|
|
}`
|
|
|
|
return (
|
|
<div className="bg-white h-screen overflow-y-auto" style={{ width: '500px' }}>
|
|
<h3 className="p-5 text-2xl">MobX</h3>
|
|
<div className="p-5">
|
|
<div>
|
|
This plugin allows you to capture MobX events 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">Installation</div>
|
|
<CodeBlock language={'bash'} code={`npm i @openreplay/tracker-mobx --save`} />
|
|
|
|
<div className="font-bold my-2">Usage</div>
|
|
<p>
|
|
Initialize the @openreplay/tracker package as usual and load the plugin into it. Then put the generated middleware into your Redux
|
|
chain.
|
|
</p>
|
|
<div className="py-3" />
|
|
|
|
<div className="font-bold my-2">Usage</div>
|
|
<ToggleContent
|
|
label="Server-Side-Rendered (SSR)?"
|
|
first={<CodeBlock language={'js'} code={mobxUsage} />}
|
|
second={<CodeBlock language={'jsx'} code={mobxUsageCjs} />}
|
|
/>
|
|
|
|
<DocLink className="mt-4" label="Integrate MobX" url="https://docs.openreplay.com/plugins/mobx" />
|
|
</div>
|
|
</div>
|
|
);
|
|
};
|
|
|
|
MobxDoc.displayName = 'MobxDoc';
|
|
|
|
export default observer(MobxDoc)
|