@londondynamics/pericles-webcomponent v2.1.0

Introducing Pericles: The London Dynamics Configurator

Pericles (/ˈpɛrɪkliːz/) is the project name for the London Dynamics 3D (and 2D) configurator service. Designed with versatility and ease of integration in mind, this package allows you to embed a dynamic and interactive scene directly onto your web page using a simple Web Component.

The Pericles project includes:

• Pericles JS: JavaScript widget with a common implementation API (legacy)
• Pericles Web Component: A Web Component following HTML standards (you are here)
• Pericles React: TBA

Demo

👉 Try it out in our storybook 👈

Installation

npm install @londondynamics/pericles-webcomponent

Usage

<script
  type="module"
  src="node_modules/@londondynamics/pericles-webcomponent/dist/configurator.js"
></script>

<ld-configurator customerId="your-customer-id" sku="your-scene-sku">
</ld-configurator>

See all our examples in action.

Configuration

The Pericles web component requires the following attributes:

• customerId: Your customer ID
• sku: The SKU of the scene you wish to embed OR
• sceneId: The permanent ID of the scene you wish to embed OR
• hash: The hash code of a previously saved configuration

!TIP For more information on configuring the visualiser, please visit the SDK Documentation

License

This project is licensed under the terms of the MIT license.