# tridi

> JavaScript 360 3D Product Viewer

Latest version **2.0.3** (published 2021-08-30) · MIT license · 0 weekly downloads

> **Deprecated.** This package is deprecated.

## Install

```sh
npm install tridi
pnpm add tridi
yarn add tridi
bun add tridi
```

## Health

**Score 10/100 (F)** — status: deprecated.

Negative: deprecated.

## Facts

| | |
|---|---|
| Version | 2.0.3 |
| Published | 2021-08-30 |
| First published | 2019-03-30 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 129.1 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 40 |
| Author | Łukasz Wójcik |
| Maintainers | lwojcik |
| Keywords | 3d, 360, image, photo, product, view, viewer |

## Links

- npm: https://www.npmjs.com/package/tridi
- Repository: https://github.com/tridijs/tridi
- Homepage: https://tridi.lukem.net
- Issues: https://github.com/tridijs/tridi/issues
- npm.io page: https://npm.io/package/tridi

## Alternatives

- [exif-parser](https://npm.io/package/exif-parser.md) — 3.8M weekly downloads
- [vite-plugin-compression](https://npm.io/package/vite-plugin-compression.md) — 569.5K weekly downloads
- [pica](https://npm.io/package/pica.md) — 442.4K weekly downloads
- [@reportportal/client-javascript](https://npm.io/package/@reportportal/client-javascript.md) — 408.8K weekly downloads
- [@tldraw/state](https://npm.io/package/@tldraw/state.md) — 316.0K weekly downloads

## Recent versions

- 2.0.3 (latest) — 2021-08-30
- 2.0.2 — 2021-01-09
- 2.0.1 — 2021-01-09
- 2.0.0 — 2021-01-09
- 1.2.1 — 2020-12-30
- 1.2.0 — 2019-05-20
- 1.1.2 — 2019-05-15
- 1.1.1 — 2019-05-15
- 1.1.0 — 2019-05-14
- 1.0.1 — 2019-05-12
- 1.0.0 — 2019-04-10
- 0.0.11 — 2019-04-08
- 0.0.10 — 2019-04-08
- 0.0.9 — 2019-04-07
- 0.0.8 — 2019-04-07
- … 6 more at https://npm.io/package/tridi/versions

## README

# Tridi
[![npm (latest)](https://img.shields.io/npm/v/tridi/latest.svg)](https://www.npmjs.com/package/tridi)
[![Build status](https://ci.appveyor.com/api/projects/status/clyylps63lqs8x2k/branch/master?svg=true)](https://ci.appveyor.com/project/lwojcik/tridi/branch/master)
[![codecov](https://codecov.io/gh/tridijs/tridi/branch/master/graph/badge.svg?token=3c2TX2NWAE)](https://codecov.io/gh/tridijs/tridi)

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

![Tridi in action (GIF)](https://raw.githubusercontent.com/tridijs/tridi/master/dist/images/example.gif)

## Install

```
npm install tridi
```

## Download

* [Latest release](https://github.com/tridijs/tridi/releases/latest) — full package from GitHub
* [Source code](https://raw.githubusercontent.com/tridijs/tridi/master/src/tridi.ts) — contains full uncompiled TypeScript source code
* [Compiled version](https://tridi.lukem.net/js/tridi.js) — contains unminified JS code
* [Production-ready version](https://tridi.lukem.net/js/tridi.min.js) — minified JS code

## Quick start
Import Tridi as a module:

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

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

```HTML
<script src="path/to/tridi.js"></script>
```
For minimum styling add [tridi.css](https://tridi.lukem.net/css/tridi.css) to head section of your page:
```HTML
<link rel="stylesheet" href="path/to/tridi.css">
```

See [Basic viewer](https://tridi.lukem.net/examples/basic.html) for a minimal viable example.

## Using React?

Check out [react-tridi](https://github.com/nevestuan/react-tridi) by [Tuan Pham](https://github.com/nevestuan) which implements Tridi as a fully fledged React component.

For a thin component wrapper on top of the original library, see [react-tridi-wrapper](https://www.npmjs.com/package/react-tridi-wrapper).</p>

## Documentation

See [tridi.lukem.net](https://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](https://github.com/tridijs/tridi/blob/master/CONTRIBUTING.md) and [Code of Conduct](https://github.com/tridijs/tridi/blob/master/CODE_OF_CONDUCT.md).

## Acknowledgements

Tridi was loosely inspired by [3D-Product-Viewer-JavaScript-Plugin](https://github.com/Jeya-Prakash/3D-Product-Viewer-JavaScript-Plugin) by [Jeya Prakash](https://github.com/Jeya-Prakash).

## License

Licensed under MIT License. See [LICENSE](https://github.com/tridijs/tridi/blob/master/LICENSE) for more information.

---
_Source: https://npm.io/package/tridi · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._