1.3.0 • Published 4 years ago
@pulpoar/sdk-react
React Implementation of @pulpoar/sdk-core
Basic Usage
npm i @pulpoar/sdk-react
import React from 'react';
import PulpoAR, { Core } from '@pulpoar/sdk-react';
const websiteId = 'Your website id';
function App() {
const onPulpoarMounted = ({ Core }) => {
console.log('PulpoAR Core mounted');
Core.start();
};
const onPulpoarStarted = () => {
console.log('PulpoAR Core started');
};
const onScreenChanged = ({ data }) => {
console.log('Screen changed', data);
};
const handleOpenChooseModelScreen = () => {
Core.changeScreen(2);
};
return (
<>
<PulpoAR
websiteId={websiteId}
autoStart={false}
onMounted={onPulpoarMounted}
onStarted={onPulpoarStarted}
onScreenChange={onScreenChanged}
/>
<button onClick={handleOpenChooseModelScreen}>Open Choose Model</button>
</>
);
}
export default App;
| Params | Description |
|---|
| websiteId | Partners web site id |
| autoStart | Starts core automatically |
| targetElementId | element id to render the plugin |
| pluginHeight | Plugin iframe height |
| pluginWidth | Plugin iframe width |
| disableLoader | Hides loader spinner |
| disableError | Hides errors |
| Functions | Description |
|---|
| mount | Mounts core |
| start | Starts core |
| stop | Stops core |
| changeScreen | Changes plugin screen |
| Events | Description |
|---|
| onMounted | Fires on core mounted |
| onStarted | Fires on core started |
| onError | Fires on core errors |
| onScreenChange | Fires on plugin screen changes |