Tridi v2 - JavaScript 360 3D Product Viewer

npm (tag)

Looking for older version? Read Tridi v1 documentation or how to upgrade to version 2

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

Install from npm

npm install tridi

Manual build

Node.js (LTS or latest) required.

git clone https://github.com/tridijs/tridi
npm install
npm run lint
npm run test
npm run build

Download

Quick start

Install via npm:

npm install --save tridi

Import 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

Notes

Examples

Bugs / contributions

See list of open issues or create a new issue / feature request

To contribute, fork a repository and submit a pull request.

Acknowledgements

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

License

Licensed under MIT License. See LICENSE for more information.

© 2019-2021 Łukasz Wójcik