@cognite/3d-wrapper-react

React Component library for the 3D viewer

Usage no npm install needed!

<script type="module">
  import cognite3dWrapperReact from 'https://cdn.skypack.dev/@cognite/3d-wrapper-react';
</script>

README

3d-wrapper-react

3D-wrapper-react is the npm package for easy inclusion of the Cognite 3d-viewer in a react-based application.

Getting Started

This section will get your copy building and running the react wrapper.

Installation

Please follow installation instructions from the root folder to install this package with locally linked dependencies.

Usage

WARNING: If any changes are made to the linked dependencies build the dependencies before you use this poackage.

yarn build

Makes a production ready library ready for publishing to NPM.

yarn storybook

Starts a webpage which displays several different configurations for the react viewer.

Testing

yarn test

Will run a set of tests on the current state of the package.

Publishing

Publishing should be done in the root folder to maintain version control