Options
All
  • Public
  • Public/Protected
  • All
Menu

@byondrnd/byondxr-web-visualizer-ui

Visualizer UI Documentation

Get Started

<html>
  <head>
    <link
      href="https://unpkg.com/@byondrnd/byondxr-web-visualizer-ui@2.1.45/build/index.css"
      rel="stylesheet"
    />
  </head>
  <body>
    <div class="visualizer" data-role="visualizer" experienceId="<your experience id here>"></div>
    <script src="https://unpkg.com/@byondrnd/byondxr-web-visualizer@2.1.23/dist/index.js"></script>
    <script src="https://unpkg.com/@byondrnd/byondxr-web-visualizer-ui@2.1.45/build/index.js"></script>
  </body>
</html>

this project is a plugin for the visualizer, see https://www.npmjs.com/package/@byondrnd/byondxr-web-visualizer for more information

Customization, Theming Supported & css variables

It can be given as a configuration linked to the experienceId Otherwise as a HTML and CSS as in the examples bellow..

To override a css rules, add them to: https://unpkg.com/@byondrnd/byondxr-web-visualizer-ui@2.1.45/doc/modules/src_app_iconstants.html#icssvariables These are the possible css variables: https://unpkg.com/@byondrnd/byondxr-web-visualizer-ui@2.1.45/build/examples/globalVariables.css

Changing constant titles labels and icons

pass a stringified object as an attribute into the base div element

example

<html>
  <head>
    <link
      href="https://unpkg.com/@byondrnd/byondxr-web-visualizer-ui@2.1.45/build/index.css"
      rel="stylesheet"
    />
  </head>
  <body>
    <div
      class="visualizer"
      data-role="visualizer"
      experienceId="<your experience id here>"
      constants='{"menu":{"hotspots":{"label":"Hotspots"}}}'
    ></div>
    <script src="https://unpkg.com/@byondrnd/byondxr-web-visualizer@2.1.23/dist/index.js"></script>
    <script src="https://unpkg.com/@byondrnd/byondxr-web-visualizer-ui@2.1.45/build/index.js"></script>
  </body>
</html>

a full Documentation of custom labels titles and icons can be found under the Constants section

https://unpkg.com/@byondrnd/byondxr-web-visualizer-ui@2.1.45/doc/modules/src_app_iconstants.html

an example for a constant object can be found at

https://unpkg.com/@byondrnd/byondxr-web-visualizer-ui@2.1.45/build/examples/Constants.json"

Client API

It is accessed through an object that is attached to the visualizer container:

const container = document.querySelector('[data-role="visualizer"]')
container.visualizerUI.showAddToCart('sku')

Documentation of the methods available on that object: https://unpkg.com/@byondrnd/byondxr-web-visualizer-ui@2.1.45/doc/modules/src_app_clientapitypes.html

Launcher

Documentation: https://unpkg.com/@byondrnd/byondxr-web-visualizer-ui@2.1.23/doc/modules/generated_doc_launchertypes.html

example:

        <button
            onClick={() => {
                window.launchVisualizer({
                    experienceId: 'G2GcP2',
                    defaultProducts: { Countertop: '1200302000' },
                    defaultProduct: '1200302000',
                    productsList: ['1200302000', '334442000']
                    sceneId: '6',
                    scene_configuration: 'US-EN',
                    favoriteProducts: [ {product: {application: 'Backsplash', sku: '1040502005'}} ]
                }).then((visualizerContainer)=>{
                    // Here the visualizer is loaded and you can do with it whatever you need such as:
                    visualizerContainer.visualizerUI.showAddToCart('sku')
                    visualizerContainer.visualizer.setFavoriteProducts([ {product: {application: 'Backsplash', sku: '1040502005'}} ])
                })
            }}
        >
            Launch
        </button>

Generated using TypeDoc