Skip to content

Getting Started

Waku is a flexible plugin that simplifies the process of mounting components in your Vue applications. Whether you want to create popups, tooltips, or other dynamically mountable elements, Waku has you covered.

Installation

txt
bun add @subwaytime/waku
txt
npm add @subwaytime/waku
txt
pnpm add @subwaytime/waku

Usage

Once you've installed Waku, you can start using it in your Vue application.
Here's a basic example of how to get started:

  1. Import Waku Plugin In your Vue component or main JavaScript file, import createWaku:
ts
import { createApp } from 'vue';
import { createWaku } from '@subwaytime/waku';
import App from './app.vue';

const instance = createApp();
instance.use(createWaku());
instance.mount(App);
  1. Add WakuMointPoint to your vue mount component
vue
> app.vue
<template>
  <WakuMointPoint />
</template>
  1. Create a mountable Component
vue
<template>
  <div>
    <h1> MODAL </h1>
  </div>
</template>
  1. Mount your component
ts
const { id, vNode, el, visible, destroy } = mountComponent(Modal);

Check out the features for detailed information on configuration options and advanced usage.

That's it! You've successfully integrated Waku into your Vue application. Feel free to explore the library's features and customize mountable components to suit your needs.

Happy mounting!

Released under the MIT License.