Copyright © Bentley Systems, Incorporated. All rights reserved.
The iTwin Viewer is a configurable iTwin.js viewer. This monorepo contains the iTwin Viewer npm packages, as well as sample applications to provide examples of their usage. Each package in the repository contains a README with specific information pertaining to the package.
| Name | Folder | Description | Version |
|---|---|---|---|
| @itwin/viewer-react | packages/modules/viewer-react | Contains the base iTwin Viewer React component |  |
| @itwin/desktop-viewer-react | packages/modules/desktop-viewer-react | Contains the desktop version of the iTwin Viewer React component |  |
| @itwin/web-viewer-react | packages/modules/web-viewer-react | Contains the web version of the iTwin Viewer React component |  |
| itwin-web-viewer-template | packages/templates/web | Template that contains the iTwin Web Viewer | Clone with degit for a quick start |
| itwin-desktop-viewer-template | packages/templates/desktop | Template that contains the iTwin Desktop Viewer | Clone with degit for a quick start |
This is a template for web applications that are based on the iTwin Viewer built using Vite.
To create a new app based on this template run:
npx degit iTwin/viewer/packages/templates/web#master my-app-nameNote: If you're using the template directly from this repository, you might notice missing icons when running the app with pnpm start. To resolve this, run:
pnpm run build && pnpm run previewThis ensure that the icons render correctly.
This is a template for Desktop applications that are based on the iTwin Viewer built using Vite.
To create a new app based on this template run:
npx degit iTwin/viewer/packages/templates/desktop#master my-app-nameNote: If you're using the template directly from this repository, you might notice missing icons when running the app with pnpm start. To resolve this, run:
pnpm run build && pnpm run previewThis ensure that the icons render correctly.
For information on how to contribute to this project, please read CONTRIBUTING.