HeyokaJS

Appearance

Installation ​

Learn how to install @heyokajs/nuxt in your Nuxt application.

bash
pnpm add three @heyokajs/nuxt
bash
npm install three @heyokajs/nuxt
bash
yarn add three @heyokajs/nuxt

INFO

The module is currently in alpha and only available over NPM for select participants.

Typescript ​

Heyoka is written in Typescript and it's fully typed. If you are using Typescript, you will get the full benefit of the typings. Just make sure you install the types for three.

bash
pnpm add @types/three -D
bash
npm install @types/three -D
bash
yarn add @types/three -D

Getting started ​

You need to add @heyokajs/nuxt to your modules.

ts
export default defineNuxtConfig({
  modules: ['@heyokajs/nuxt'],
  heyoka: {
    // options
  },
})

Then you can use it directly in your component

vue
<script setup lang="ts">
// import { Canvas } from '@heyokajs/nuxt'
</script>

<template>
  <Canvas />
</template>