102 lines
3.1 KiB
TypeScript
102 lines
3.1 KiB
TypeScript
import React from 'react';
|
|
import Highlight from 'react-highlight';
|
|
import ToggleContent from '../../../shared/ToggleContent';
|
|
import DocLink from 'Shared/DocLink/DocLink';
|
|
import { connect } from 'react-redux';
|
|
|
|
const PiniaDoc = (props) => {
|
|
const { projectKey } = props;
|
|
return (
|
|
<div className="bg-white h-screen overflow-y-auto" style={{ width: '500px' }}>
|
|
<h3 className="p-5 text-2xl">VueX</h3>
|
|
<div className="p-5">
|
|
<div>
|
|
This plugin allows you to capture Pinia mutations + 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-vuex --save`}</Highlight>
|
|
|
|
<div className="font-bold my-2 text-lg">Usage</div>
|
|
<p>
|
|
Initialize the @openreplay/tracker package as usual and load the plugin into it. Then put
|
|
the generated plugin into your plugins field of your store.
|
|
</p>
|
|
<div className="py-3" />
|
|
|
|
<ToggleContent
|
|
label="Server-Side-Rendered (SSR)?"
|
|
first={
|
|
<Highlight className="js">
|
|
{`import Vuex from 'vuex'
|
|
import OpenReplay from '@openreplay/tracker';
|
|
import trackerVuex from '@openreplay/tracker-vuex';
|
|
//...
|
|
const tracker = new OpenReplay({
|
|
projectKey: '${projectKey}'
|
|
});
|
|
tracker.start();
|
|
//...
|
|
const examplePiniaStore = useExamplePiniaStore()
|
|
// check list of available options below
|
|
const vuexPlugin = tracker.use(trackerVuex(<options>))
|
|
// add a name to your store, optional
|
|
//(will be randomly generated otherwise)
|
|
const piniaStorePlugin = vuexPlugin('STORE NAME')
|
|
|
|
// start tracking state updates
|
|
piniaStorePlugin(examplePiniaStore)
|
|
// now you can use examplePiniaStore as
|
|
// usual pinia store
|
|
// (destructure values or return it as a whole etc)
|
|
`}
|
|
</Highlight>
|
|
}
|
|
second={
|
|
<Highlight className="js">
|
|
{`import Vuex from 'vuex'
|
|
import OpenReplay from '@openreplay/tracker/cjs';
|
|
import trackerVuex from '@openreplay/tracker-vuex/cjs';
|
|
//...
|
|
const tracker = new OpenReplay({
|
|
projectKey: '${projectKey}'
|
|
});
|
|
//...
|
|
|
|
// start tracker when the app is mounted
|
|
tracker.start();
|
|
|
|
//...
|
|
const examplePiniaStore = useExamplePiniaStore()
|
|
// check list of available options below
|
|
const vuexPlugin = tracker.use(trackerVuex(<options>))
|
|
// add a name to your store, optional
|
|
// (will be randomly generated otherwise)
|
|
const piniaStorePlugin = vuexPlugin('STORE NAME')
|
|
|
|
// start tracking state updates
|
|
piniaStorePlugin(examplePiniaStore)
|
|
// now you can use examplePiniaStore as
|
|
// usual pinia store
|
|
// (destructure values or return it as a whole etc)
|
|
}`}
|
|
</Highlight>
|
|
}
|
|
/>
|
|
|
|
<DocLink
|
|
className="mt-4"
|
|
label="Integrate Vuex"
|
|
url="https://docs.openreplay.com/plugins/pinia"
|
|
/>
|
|
</div>
|
|
</div>
|
|
);
|
|
};
|
|
|
|
PiniaDoc.displayName = 'PiniaDoc';
|
|
|
|
export default connect((state) => ({
|
|
projectKey: state.getIn(['site', 'instance', 'projectKey']),
|
|
}))(PiniaDoc);
|