YZYLAB / vue-spline

A spline.design wrapper for VueJS to add 3D animations easily into your Vue projects

Vue Spline

A spline.design wrapper for VueJS to add 3D animations easily into your Vue projects

Demo

📖 Getting Started

Install the vue-spline package with npm

$ npm install vue-spline

Install the vue-spline package with yarn

$ yarn add vue-spline

💻 Usage

Import the Spline component

import Spline from 'vue-spline';
Vue.component(Spline);

Using it inside a template

<spline :scene=YOUR_SCENE_OBJECT_HERE />

📝 Properties

- id (Id that you want to give the canvas)
- scene (The JSON scene from spline.design, required)
- className (Class name for the container element)
- canvasStyle (Pass custom css to the canvas element)
- containerStyle (Pass custom css to the container element)

Development

Want to contribute? Great!

To fix a bug or enhance an existing module, follow these steps:

• Fork the repo
• Create a new branch (git checkout -b improve-feature)
• Make the appropriate changes in the files
• Add changes to reflect the changes made
• Commit your changes (git commit -am 'Improve feature')
• Push to the branch (git push origin improve-feature)
• Create a Pull Request

🐛 ### Bug / Feature Request

If you find a bug kindly open an issue here

If you'd like to request a new function, feel free to do so by opening an issue here.

Inspired by