1.3.0 • Published 2 years ago

@pulpoar/sdk-react v1.3.0

Weekly downloads
-
License
ISC
Repository
github
Last release
2 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;
ParamsDescription
websiteIdPartners web site id
autoStartStarts core automatically
targetElementIdelement id to render the plugin
pluginHeightPlugin iframe height
pluginWidthPlugin iframe width
disableLoaderHides loader spinner
disableErrorHides errors

FunctionsDescription
mountMounts core
startStarts core
stopStops core
changeScreenChanges plugin screen

EventsDescription
onMountedFires on core mounted
onStartedFires on core started
onErrorFires on core errors
onScreenChangeFires on plugin screen changes
1.3.0

2 years ago

1.2.0

2 years ago

1.1.2

2 years ago

1.1.1

2 years ago

1.1.0

2 years ago

1.0.1-alpha.0

2 years ago

1.0.0

2 years ago