feat(ui): add pinia integration doc

This commit is contained in:
sylenien 2022-09-09 11:27:23 +02:00
parent 0eed5b58d4
commit 3d82a6558b
4 changed files with 106 additions and 0 deletions

File diff suppressed because one or more lines are too long

After

Width:  |  Height:  |  Size: 5.2 KiB

View file

@ -29,6 +29,7 @@ import AssistDoc from './AssistDoc';
import { PageTitle, Loader } from 'UI';
import AnimatedSVG, { ICONS } from 'Shared/AnimatedSVG/AnimatedSVG';
import withPageTitle from 'HOCs/withPageTitle';
import PiniaDoc from './PiniaDoc'
interface Props {
fetch: (name: string, siteId: string) => void;
@ -162,6 +163,7 @@ const integrations = [
integrations: [
{ title: 'Redux', slug: '', icon: 'integrations/redux', component: <ReduxDoc /> },
{ title: 'VueX', slug: '', icon: 'integrations/vuejs', component: <VueDoc /> },
{ title: 'Pinia', slug: '', icon: 'integrations/pinia', component: <PiniaDoc /> },
{ title: 'GraphQL', slug: '', icon: 'integrations/graphql', component: <GraphQLDoc /> },
{ title: 'NgRx', slug: '', icon: 'integrations/ngrx', component: <NgRxDoc /> },
{ title: 'MobX', slug: '', icon: 'integrations/mobx', component: <MobxDoc /> },

View file

@ -0,0 +1,102 @@
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);

View file

@ -0,0 +1 @@
export { default } from './PiniaDoc'