0.0.1 • Published 1 year ago

ngx-model-viewer v0.0.1

Weekly downloads
-
License
-
Repository
-
Last release
1 year ago

3D model viewer

This library was generated with Angular CLI version 15.2.0.

Angular component for displaying 3D Objects in browsers

Prerequisites

This project requires NodeJS (version 14 or later) and NPM. Node and NPM are really easy to install. To make sure you have them available on your machine, try running the following command.

$ npm -v && node -v
8.5.5
v16.13.2

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

Installation

BEFORE YOU INSTALL: please read the prerequisites

Start with install this package on your project:

$ npm i ngx-model-viewer

Or if you prefer using Yarn:

$ yarn add ngx-model-viewer

Build

Run ng build ngx-model-viewer to build the project. The build artifacts will be stored in the dist/ directory.

Publishing

After building your library with ng build ngx-model-viewer, go to the dist folder cd dist/ngx-model-viewer and run npm publish.

Running unit tests

Run ng test ngx-model-viewer to execute the unit tests via Karma.

Further help

To get more help on the Angular CLI use ng help or go check out the Angular CLI Overview and Command Reference page.

Usage

API

NgxModelViewerComponent

<ngx-model-viewer [fileUrl]="MyModelFileURL"></ngx-model-viewer>

Downloads and displays the model with .stl extension only

Props

fileUrl

TypeDefault value
string''

Url string for download the model for viewing

## Built With

- Angular
- ThreeJS
- Love

## Authors

- **Digifabster Inc.**
0.0.1

1 year ago