Skip to content
/ vue-gl Public
forked from vue-gl/vue-gl

Vue.js components rendering 3D WebGL graphics reactively with three.js

License

Notifications You must be signed in to change notification settings

xytoki/vue-gl

 
 

Repository files navigation

Notes of this fork

This is a temporary fork version of VueGL to work with vue3. Tests are not changed so they may all fail.

VueGL

Vue.js components rendering 3D WebGL graphics reactively with three.js.

NPM
FOSSA Status
CircleCI
codecov
Financial Contributors on Open Collective

Usage

<!-- Load scripts -->
<script src="https://unpkg.com/vue"></script>
<script src="https://unpkg.com/three"></script>
<script src="https://unpkg.com/vue-gl"></script>

<!-- Define canvas and objects -->
<vgl-renderer id="vgl-canvas">
  <vgl-sphere-geometry name="sphere"></vgl-sphere-geometry>
  <vgl-scene>
    <vgl-mesh geometry="sphere"></vgl-mesh>
  </vgl-scene>
  <vgl-perspective-camera orbit-position="5 0 0"></vgl-perspective-camera>
</vgl-renderer>

<!-- Register components and start vue -->
<script>
Object.keys(VueGL).forEach(name => Vue.component(name, VueGL[name]));
new Vue({ el: "#vgl-canvas" });
</script>

See the documentation for more information.

Available components

Components reference shows a list of available core components. Example components reference also introduces additional components you can use immediately.

The list of components not implemented yet can be found at this project.

Contribution

Are you interested in enhance this product? We're really glad and thanks a lot!
See Contributing guidelines to get started.

Code Contributors

This project exists thanks to all the people who contribute. [Contribute].

Financial Contributors

Become a financial contributor and help us sustain our community. [Contribute]

Individuals

Organizations

Support this project with your organization. Your logo will show up here with a link to your website. [Contribute]

License

FOSSA Status

About

Vue.js components rendering 3D WebGL graphics reactively with three.js

Resources

License

Code of conduct

Stars

Watchers

Forks

Packages

No packages published

Languages

  • JavaScript 97.9%
  • Ruby 2.1%