Gathering detailed insights and metrics for @react-three/drei
Gathering detailed insights and metrics for @react-three/drei
🥉 useful helpers for react-three-fiber
Installations
npm install @react-three/dreiDeveloper Guide
BETA
Typescript
Yes
Module System
CommonJS
Node Version
22.9.0
NPM Version
10.9.0
Score
84.7
Supply Chain
83.3
Quality
96.8
Maintenance
100
Vulnerability
98.9
License
Releases
874
Languages
6
JavaScript
TypeScript
Shell
HTML
CSS
GLSL
JavaScript (59.25%)
TypeScript (40.54%)
Shell (0.17%)
HTML (0.02%)
CSS (0.01%)
GLSL (0.01%)
Developer
Download Statistics
Total Downloads
30,199,093
Last Day
29,404
Last Week
452,786
Last Month
1,911,548
Last Year
14,995,614
GitHub Statistics
MIT License
9,027 Stars
2,211 Commits
757 Forks
49 Watchers
85 Branches
255 Contributors
Updated on Jul 01, 2025
Bundle Size
1.56 MB
Minified
486.97 kB
Minified + Gzipped
Maintainers
6
Package Meta Information
Latest Version
10.3.0
Package Id
@react-three/drei@10.3.0
Unpacked Size
1.67 MB
Size
460.44 kB
File Count
482
NPM Version
10.9.0
Node Version
22.9.0
Published on
Jun 15, 2025
Total Downloads
Cumulative downloads
Total Downloads
30,199,093
Last Day
-30.2%
29,404
Compared to previous day
Last Week
-12.6%
452,786
Compared to previous week
Last Month
10.8%
1,911,548
Compared to previous month
Last Year
77.6%
14,995,614
Compared to previous year
Weekly Downloads
Monthly Downloads
Yearly Downloads
Dependencies
21
Peer Dependencies
4
A growing collection of useful helpers and fully functional, ready-made abstractions for @react-three/fiber.
If you make a component that is generic enough to be useful to others, think about CONTRIBUTING!
1npm install @react-three/drei
[!IMPORTANT] this package is using the stand-alone
three-stdlibinstead ofthree/examples/jsm.
Basic usage
1import { PerspectiveCamera, PositionalAudio, ... } from '@react-three/drei'
React-native
1import { PerspectiveCamera, PositionalAudio, ... } from '@react-three/drei/native'
The native route of the library does not export Html or Loader. The default export of the library is web which does export Html and Loader.
Documentation
Old doc
[!WARNING] Below is an archive of the anchors links with their new respective locations to the documentation website. Do not update the links below, they are for reference only.
Cameras
PerspectiveCamera
OrthographicCamera
CubeCamera
Controls
CameraControls
ScrollControls
PresentationControls
KeyboardControls
FaceControls
MotionPathControls
Gizmos
GizmoHelper
PivotControls
DragControls
TransformControls
Grid
Helper / useHelper
Shapes
Plane, Box, Sphere, Circle, Cone, Cylinder, Tube, Torus, TorusKnot, Ring, Tetrahedron, Polyhedron, Icosahedron, Octahedron, Dodecahedron, Extrude, Lathe, Shape
RoundedBox
ScreenQuad
Line
QuadraticBezierLine
CubicBezierLine
CatmullRomLine
Facemesh
Abstractions
Image
Text
Text3D
Effects
PositionalAudio
Billboard
ScreenSpace
ScreenSizer
GradientTexture
Edges
Outlines
Trail
Sampler
ComputedAttribute
Clone
useAnimations
MarchingCubes
Decal
Svg
AsciiRenderer
Splat
Shaders
MeshReflectorMaterial
MeshWobbleMaterial
MeshDistortMaterial
MeshRefractionMaterial
MeshTransmissionMaterial
MeshDiscardMaterial
PointMaterial
SoftShadows
shaderMaterial
Modifiers
CurveModifier
Misc
useContextBridge
Example
Html
CycleRaycast
Select
Sprite Animator
Stats
StatsGl
Wireframe
useDepthBuffer
Fbo / useFBO
useCamera
CubeCamera / useCubeCamera
DetectGPU / useDetectGPU
useAspect
useCursor
useIntersect
useBoxProjectedEnv
Trail / useTrail
useSurfaceSampler
FaceLandmarker
Loading
Loader
Progress / useProgress
Gltf / useGLTF
Fbx / useFBX
Texture / useTexture
Ktx2 / useKTX2
CubeTexture / useCubeTexture
VideoTexture / useVideoTexture
TrailTexture / useTrailTexture
useFont
useSpriteLoader
Performance
Instances
Merged
Points
Segments
Detailed
Preload
BakeShadows
meshBounds
AdaptiveDpr
AdaptiveEvents
Bvh
PerformanceMonitor
Portals
Hud
View
RenderTexture
RenderCubeTexture
Fisheye
Mask
MeshPortalMaterial
Staging
Center
Resize
BBAnchor
Bounds
CameraShake
Float
Stage
Backdrop
Shadow
Caustics
ContactShadows
RandomizedLight
AccumulativeShadows
SpotLight
SpotLightShadow
Environment
Lightformer
Sky
Stars
Sparkles
Cloud
useEnvironment
MatcapTexture / useMatcapTexture
NormalTexture / useNormalTexture
ShadowAlpha
Dev
INSTALL
1$ corepack enable 2$ yarn install
Test
Local
Pre-requisites:
-
1$ npx playwright install
To run visual tests locally:
1$ yarn build 2$ yarn test
To update a snapshot:
1$ PLAYWRIGHT_UPDATE_SNAPSHOTS=1 yarn test
Docker
[!IMPORTANT] Snapshots are system-dependent, so to run playwright in the same environment as the CI:
1$ docker run --init --rm \ 2 -v $(pwd):/app -w /app \ 3 ghcr.io/pmndrs/playwright:drei \ 4 sh -c "corepack enable && yarn install && yarn build && yarn test"
To update a snapshot:
1$ docker run --init --rm \ 2 -v $(pwd):/app -w /app \ 3 -e PLAYWRIGHT_UPDATE_SNAPSHOTS=1 \ 4 ghcr.io/pmndrs/playwright:drei \ 5 sh -c "corepack enable && yarn install && yarn build && yarn test"
No vulnerabilities found.
Reason
14 commit(s) and 1 issue activity found in the last 90 days -- score normalized to 10
Reason
no dangerous workflow patterns detected
Reason
license file detected
Details
- Info: project has a license file: LICENSE:0
- Info: FSF or OSI recognized license: MIT License: LICENSE:0
Reason
binaries present in source code
Details
- Warn: binary detected: .storybook/public/draco-gltf/draco_decoder.wasm:1
Reason
Found 13/29 approved changesets -- score normalized to 4
Reason
detected GitHub workflow tokens with excessive permissions
Details
- Warn: no topLevel permission defined: .github/workflows/docs.yml:1
- Warn: no topLevel permission defined: .github/workflows/release.yml:1
- Info: no jobLevel write permissions found
Reason
no effort to earn an OpenSSF best practices badge detected
Reason
security policy file not detected
Details
- Warn: no security policy file detected
- Warn: no security file to analyze
- Warn: no security file to analyze
- Warn: no security file to analyze
Reason
branch protection not enabled on development/release branches
Details
- Warn: branch protection not enabled for branch 'master'
- Warn: branch protection not enabled for branch 'canary-test01'
Reason
SAST tool is not run on all commits -- score normalized to 0
Details
- Warn: 0 commits out of 24 are checked with a SAST tool
Reason
project is not fuzzed
Details
- Warn: no fuzzer integrations found
Reason
dependency not pinned by hash detected -- score normalized to 0
Details
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/docs.yml:41: update your workflow using https://app.stepsecurity.io/secureworkflow/pmndrs/drei/docs.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/release.yml:26: update your workflow using https://app.stepsecurity.io/secureworkflow/pmndrs/drei/release.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/release.yml:28: update your workflow using https://app.stepsecurity.io/secureworkflow/pmndrs/drei/release.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/release.yml:39: update your workflow using https://app.stepsecurity.io/secureworkflow/pmndrs/drei/release.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/release.yml:41: update your workflow using https://app.stepsecurity.io/secureworkflow/pmndrs/drei/release.yml/master?enable=pin
- Warn: npmCommand not pinned by hash: test/e2e/e2e.sh:42
- Warn: npmCommand not pinned by hash: test/e2e/e2e.sh:42
- Warn: npmCommand not pinned by hash: test/e2e/e2e.sh:68
- Warn: npmCommand not pinned by hash: test/e2e/e2e.sh:95
- Info: 0 out of 5 GitHub-owned GitHubAction dependencies pinned
- Info: 0 out of 4 npmCommand dependencies pinned
Reason
17 existing vulnerabilities detected
Details
- Warn: Project is vulnerable to: GHSA-968p-4wvh-cqc8
- Warn: Project is vulnerable to: GHSA-x4c5-c7rf-jjgv
- Warn: Project is vulnerable to: GHSA-h5c3-5r3r-rr8q
- Warn: Project is vulnerable to: GHSA-rmvr-2pp2-xj38
- Warn: Project is vulnerable to: GHSA-xx4v-prfh-6cgc
- Warn: Project is vulnerable to: GHSA-v6h2-p8h4-qcjw
- Warn: Project is vulnerable to: GHSA-3xgq-45jj-v275
- Warn: Project is vulnerable to: GHSA-67mh-4wv8-2f99
- Warn: Project is vulnerable to: GHSA-78xj-cgh5-2h22
- Warn: Project is vulnerable to: GHSA-2p57-rm9w-gvfp
- Warn: Project is vulnerable to: GHSA-mwcw-c2x4-8c55
- Warn: Project is vulnerable to: GHSA-vg6x-rcgg-rjx6
- Warn: Project is vulnerable to: GHSA-x574-m823-4x7w
- Warn: Project is vulnerable to: GHSA-4r4m-qw57-chr8
- Warn: Project is vulnerable to: GHSA-xcj6-pq6g-qj4x
- Warn: Project is vulnerable to: GHSA-356w-63v5-8wf4
- Warn: Project is vulnerable to: GHSA-859w-5945-r5v3
Score
3.7
/10
Last Scanned on 2025-06-23
The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.
Learn More