# tiny-viewer

> This project created for easy displaying 3D scenes in React applications using three.js

Latest version **2.0.0** (published 2023-01-22) · ISC license · 0 weekly downloads

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

## Install

```sh
npm install tiny-viewer
pnpm add tiny-viewer
yarn add tiny-viewer
bun add tiny-viewer
```

## Health

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

Negative: deprecated.

## Facts

| | |
|---|---|
| Version | 2.0.0 |
| Published | 2023-01-22 |
| First published | 2023-01-07 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 4 |
| Unpacked size | 588.9 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 2 |
| Author | Alexey Degtyarik |
| Maintainers | muhmundr |
| Keywords | viewer, 3d models, glb, gltf, loader, three.js, react |

## Links

- npm: https://www.npmjs.com/package/tiny-viewer
- Repository: https://github.com/LEMing/TinyViewer
- Homepage: https://github.com/LEMing/TinyViewer#readme
- Issues: https://github.com/LEMing/TinyViewer/issues
- npm.io page: https://npm.io/package/tiny-viewer

## Dependencies (4)

- [sass](https://npm.io/package/sass.md) ^1.50.0
- [lodash](https://npm.io/package/lodash.md) ^4.17.21
- [classnames](https://npm.io/package/classnames.md) ^2.3.1
- [typescript](https://npm.io/package/typescript.md) ^4.6.3

## Alternatives

- [mobx-react](https://npm.io/package/mobx-react.md) — 2.8M weekly downloads
- [rc-tree](https://npm.io/package/rc-tree.md) — 2.6M weekly downloads
- [@react-oauth/google](https://npm.io/package/@react-oauth/google.md) — 1.3M weekly downloads
- [@wagmi/connectors](https://npm.io/package/@wagmi/connectors.md) — 877.0K weekly downloads
- [vee-validate](https://npm.io/package/vee-validate.md) — 836.4K weekly downloads

## Recent versions

- 2.0.0 (latest) — 2023-01-22
- 1.1.6 — 2023-01-08
- 1.1.5 — 2023-01-08
- 1.1.4 — 2023-01-08
- 1.1.3 — 2023-01-08
- 1.1.2 — 2023-01-08
- 1.1.1 — 2023-01-08
- 1.1.0 — 2023-01-08
- 1.0.0 — 2023-01-07

## README

# TinyViewer

This project created for easy displaying 3D scenes in React applications using three.js

### Installation and Usage (CLI)

`npm install tiny-viewer`

The Viewer can be imported like this: 

```typescript
import {Viewer} from 'tiny-viewer';
```

and then used as a JSX element in a React application:

```typescript
const SmallPreview = () => {
  const modelUrl = './data/banana.glb'; // A url to a local or remote file
  const object3D = viewerUtils.loadGLB(modelUrl) // A promise of object3D
  return (
    <div className="small-preview-wrapper">
      <Viewer object3D={object3D}/>
    </div>
  )
}
```

The component takes all available space inside a wrapper and adjusts the Renderer with resize.
It should be placed inside a wrapper with defined size.
```css
.small-preview-wrapper {
  width: 1080px;
  height: 610px;
}
```

### Extra properties

The Viewer includes several optional properties for controlling the scene:

```html
<Viewer
    animationRunner={animationRunner}
    dispatchers={{setScene}}
    object3D={object3D}
    onSceneReady={onSceneReady}
    options={options}/>
```

The `animationRunner` is a function for animation loop.

The `object3D` is a promise of `THREE.Object3D`.

`Dispatchers` allow you to get access to internal objects, such as Scene, Camera, Controls and Renderer
For example, you can define a state in your app and pass the `setScene` to dispatchers to set the `scene` 
```const [scene, setScene] = useState<THREE.Scene | null>(null);```

`onSceneReady` is a simple flag that will be set to true when everything is loaded and ready to be displayed.

`options` allow us to use some pre-defined features, such as default light and helpers.

```typescript
export const DEFAULT_VIEWER_OPTIONS: ViewerOptions = {
addDefaultHelpers: true,
addDefaultLight: true,
environment: DEFAULT_ENVIRONMENT,
}
```

`environment` is a TypeScript object that defines the default options for an "Environment" in the 3D Scene.

- The `clientHeight` and `clientWidth` properties specify the dimensions of the environment in pixels.

- The `lightOptions` object contains properties for configuring the lighting in the environment:
  - `lightIntensity` is a number that specifies the intensity of the light,
  - `skyColor` is a hexadecimal color code that specifies the color of the sky,
  - `groundColor` is a hexadecimal color code that specifies the color of the ground.

- The `sceneOptions` object contains properties for configuring the scene:
    - `fog` is an object with properties for configuring fog in the scene,
    - `sceneColor` is a hexadecimal color code that specifies the overall color of the scene,
    - `envMapUrl` is a string that specifies the URL of a high dynamic range (HDR) image to use as an environment map for the scene.

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