Tridi

Tridi is a flexible JavaScript library for 360-degree 3D product visualizations based on series of images. Works on mobile and desktop browsers.

Install

npm install tridi

Download

• Latest release — full package from GitHub
• Source code — contains full uncompiled TypeScript source code
• Compiled version — contains unminified JS code
• Production-ready version — minified JS code

Quick start

Import Tridi as a module:

import * as Tridi from 'tridi';
// or:
const Tridi = require('tridi');

Or add Tridi to your site via a traditional script tag:

<script src="path/to/tridi.js"></script>

For minimum styling add tridi.css to head section of your page:

<link rel="stylesheet" href="path/to/tridi.css">

See Basic viewer for a minimal viable example.

Using React?

Check out react-tridi by Tuan Pham which implements Tridi as a fully fledged React component.

For a thin component wrapper on top of the original library, see react-tridi-wrapper.

Documentation

See tridi.lukem.net for complete documentation and examples.

Contributions

Contributions of any kind are welcome.

You can contribute to Tridi by:

• submiting bug reports or feature suggestions
• improving documentation
• submitting pull requests

Before contributing be sure to read Contributing Guidelines and Code of Conduct.

Acknowledgements

Tridi was loosely inspired by 3D-Product-Viewer-JavaScript-Plugin by Jeya Prakash.

License

Licensed under MIT License. See LICENSE for more information.