mkm-react-bim

React BIM component for MKM

Usage no npm install needed!

<script type="module">
  import mkmReactBim from 'https://cdn.skypack.dev/mkm-react-bim';
</script>

README

MKM BIM component

This is a React based component for displaying BIM models in MKM applications.

Using in a project

To use this component in a React project, run the following command in the project folder:

npm i mkm-react-bim

Then import the component where necessary:

import React from 'react';
import BimViewer from 'mkm-react-bim';

const MyComponent = () => {
    return <BimViewer />;
};

Development

Refer to /src/development for more information about developing this component.

Versioning and publishing npm package

Creating a new version

To create a new version of this component for publishing run:

npm version [patch|minor|major]

for more information about bumping version number see semantic versioning

Publishing a new version

To successfully publish the package the following requirements need to be met:

  • A new version has been created locally

  • The user has logged in to npm via npm login

After completing these actions run:

npm publish

for more information about publishing see https://docs.npmjs.com/cli/publish