nuxt

@kinematic-lab/nuxt

Warning

This package is still in alpha. We recommend only using it if you
want to test it out early, or help develop it.

Table of contents

• Relevant links
• Installation
• Composables
  • General
  • From @kinematic-lab/core

Relevant links

See changelogs: here.
See npm: here.

Installation

To use @kinematic-lab/nuxt in your project, you must first install it as a dependency. You can do this by running the following command in your terminal:

# Using pnpm
$ pnpm i @kinematic-lab/nuxt

# Using npm
$ npm i @kinematic-lab/nuxt

# Using yarn
$ yarn add @kinematic-lab/nuxt

Then add @kinematic-lab/nuxt to the modules section of nuxt.config.ts

export default defineNuxtConfig({
	modules: ['@kinematic-lab/nuxt'],
});

That's it! You can now use @kinematic-lab/nuxt in your Nuxt app ✨

Composables

@kinematic-lab/nuxt provides the following composables:

General

• onLabUpdate: See documentation.
• useLabMouse: See documentation.
• useLabViewport: See documentation.

From @kinematic-lab/core

• useLabClock: See documentation.
• useLabCubicBezier: See documentation.
• useLabVector: See documentation.