Package Health Score

58 / 100

security
No known security issues
popularity
Small
maintenance
Inactive
community
Limited

Explore Similar Packages

Security

No known security issues

All security vulnerabilities belong to production dependencies of direct and indirect packages.

Security and license risk for significant versions

Version				Vulnerabilities	License Risk
2.4.1	\|	01/2024		0 C 0 H 0 M 0 L	0 H 0 M 0 L
2.5.0	\|	01/2024		0 C 0 H 0 M 0 L	0 H 0 M 0 L
2.2.5	\|	01/2023	Popular	0 C 0 H 0 M 0 L	0 H 0 M 0 L
1.0.8	\|	11/2021		0 C 0 H 0 M 0 L	0 H 0 M 0 L

License

MIT

Security Policy

Is your project affected by vulnerabilities?

Scan your projects for vulnerabilities. Fix quickly with automated fixes. Get started with Snyk for free.

Get started free

Popularity

Small

Weekly Downloads (2,362)

GitHub Stars: 89
Forks: 16
Contributors: 2

Direct Usage Popularity

The npm package react-stl-viewer receives a total of 2,362 downloads a week. As such, we scored react-stl-viewer popularity level to be Small.

Based on project statistics from the GitHub repository for the npm package react-stl-viewer, we found that it has been starred 89 times.

Downloads are calculated as moving averages for a period of the last 12 months, excluding weekends and known missing data points.

Community

Limited

Readme.md: Yes
Contributing.md: No
Code of Conduct: No
Contributors: 2
Funding: No

This project has seen only 10 or less contributors.

We found a way for you to contribute to the project! Looks like react-stl-viewer is missing a Code of Conduct.

Embed Package Health Score Badge

Maintenance

Inactive

Commit Frequency

Open Issues: 9
Open PR: 1
Last Release: 12 months ago
Last Commit: 12 months ago

Further analysis of the maintenance status of react-stl-viewer based on released npm versions cadence, the repository activity, and other data points determined that its maintenance is Inactive.

We found that react-stl-viewer demonstrates a positive version release cadence with at least one new version released in the past 12 months.

In the past month we didn't find any pull request activity or change in issues status has been detected for the GitHub repository.

Keep your project healthy

Check your package.json

Ensure all the packages you're using are healthy and well-maintained

Snyk Vulnerability Scanner

Get health score & security insights directly in your IDE

Package

Node.js Compatibility: not defined

Age: 3 years
Dependencies: 2 Direct
Versions: 37
Install Size: 2.1 MB
Dist-tags: 1
# of Files: 27
Maintainers: 1
TS Typings: No

react-stl-viewer has more than a single and default latest tag published for the npm package. This means, there may be other tags available for this package, such as next to indicate future releases, or stable to indicate stable releases.

Readme

react-stl-viewer

React component for visualizing STLs using Three.js.

Install

npm install --save react-stl-viewer

yarn add react-stl-viewer

Usage

import React from 'react';
import ReactDOM from 'react-dom';
import {StlViewer} from "react-stl-viewer";

const url = "https://storage.googleapis.com/ucloud-v3/ccab50f18fb14c91ccca300a.stl"

const style = {
    top: 0,
    left: 0,
    width: '100vw',
    height: '100vh',
}

function App() {
    return (
        
    );
}

ReactDOM.render(, document.getElementById('root'));

Demo

You can see working the examples from .storybook/stories here

Props

Prop	Type	Required	Notes
`url`	`string`	`true`	url of the Stl file
`cameraProps`	`CameraProps`	`false`	camera properties, see below
`modelProps`	`ModelProps`	`false`	3d model properties, see below
`floorProps`	`FloorProps`	`false`	floor properties, see below
`shadows`	`boolean`	`false`	render shadows projected by the model on the ground
`showAxes`	`boolean`	`false`	show x y z axis
`orbitControls`	`boolean`	`false`	enable camera orbit controls
`extraHeaders`	`Record`	`false`	custom headers for making the http query
`onFinishLoading`	`(ev: ModelDimensions) => any`	`false`	callback triggered when Stl is fully loaded
`onError`	`(err: Error) => any`	`false`	callback triggered when an error occurred while loading Stl
`canvasId`	`string`	`false`	id of the canvas element used for rendering the model

The component also accepts <div> props

Interfaces

CameraProps

Prop	Type	Required	Notes
`ref`	`{current: CameraRef}`	`false`	reference of the camera for accessing it's properties
`initialPosition`	`CameraPosition`	`false`	set the position of the camera in geographic coordinates. The origin of coordinates is the object itself

CameraRef

Prop	Type	Required	Notes
`setCameraPosition`	`(position: CameraPosition) => any`	`true`	imperatively sets the camera position based on the provided geographic coordinates

setCameraPosition:

ModelProps

Prop	Type	Required	Notes
`ref`	`{current: ModelRef}`	`false`	reference of the 3d model for accessing it's properties
`scale`	`number`	`false`	scale of the 3d model, defaults to 1
`positionX`	`number`	`false`	x coordinate in the world of the 3d model
`positionY`	`number`	`false`	y coordinate in the world of the 3d model
`rotationX`	`number`	`false`	rotation in x axis of the model
`rotationY`	`number`	`false`	rotation in y axis of the model
`rotationY`	`number`	`false`	rotation in z axis of the model
`color`	`CSSProperties['color']`	`false`	color of the 3d model, defaults to "grey"
`geometryProps`	`(geometry: BufferGeometry) => BufferGeometry`	`false`	Perform some processing to the models geometry

FloorProps

Prop	Type	Required	Notes
`gridWidth`	`number`	`false`	if specified, a grid will be drawn in the floor with this width
`gridLength`	`number`	`false`	if specified, a grid will be drawn in the floor with this length

ModelDimensions

Prop	Type	Notes
`boundingRadius`	`number`	the radius of the bounding sphere of the 3d model before scaling
`width`	`number`	width of the 3d object
`height`	`number`	height of the 3d object
`length`	`number`	length of the 3d object

CameraPosition

Prop	Type	Required	Notes
`latitude`	`number`	`false`	camera's position latitude, it should be a number between `- Math.PI / 2` and `Math.PI / 2`, if the number exceeds the limits it will be clamped
`longitude`	`number`	`false`	camera's position longitude, it should be a number between `- Math.PI` and `Math.PI`, if the number exceeds the limits it will be clamped
`distance`	`number`	`false`	the distance factor between the object and the camera. This is a factor relative to the object size or the grid size if it's specified

react-stl-viewer dependencies

@react-three/fiber three-stdlib

FAQs

What is react-stl-viewer?

react component for visualizing 3d models in the browser using three.js. Visit Snyk Advisor to see a full health score report for react-stl-viewer, including popularity, security, maintenance & community analysis.

Is react-stl-viewer popular?

The npm package react-stl-viewer receives a total of 2,362 weekly downloads. As such, react-stl-viewer popularity was classified as small. Visit the popularity section on Snyk Advisor to see the full health analysis.

Is react-stl-viewer well maintained?

We found indications that react-stl-viewer is an Inactive project. See the full package health analysis to learn more about the package maintenance status.

Is react-stl-viewer safe to use?

The npm package react-stl-viewer was scanned for known vulnerabilities and missing license, and no issues were found. Thus the package was deemed as safe to use. See the full health analysis review.

Last updated on 23 December-2024, at 11:27 (UTC).

Build a secure application checklist

Select a recommended open source package

Minimize your risk by selecting secure & well maintained open source packages

DONE

Scan your app for vulnerabilities

Scan your application to find vulnerabilities in your: source code, open source dependencies, containers and configuration files

SCAN NOW

Fix identified vulnerabilities

Easily fix your code by leveraging automatically generated PRs

AUTO FIX

Monitor for new issues

New vulnerabilities are discovered every day. Get notified if your application is affected

MONITOR APP