Installation ​

To integrate and use VTable in your Vue application, follow the steps outlined in this section.

Install with NPM ​

To install VTable, run the following command in your terminal:

npm i vtbl

Import ​

After installing VTable, you can import it into individual Vue components or views like this:

<script setup lang="ts">
import { ref } from 'vue';

import VTable from 'vtbl';
import 'vtbl/style.css'; // Optional

const items = ref([]);
</script>

<template>
  <VTable :items="items" />
</template>

Register Globally ​

You might want to use VTable across many parts of your application. To do this, you can register it globally in your main.ts file and declare its type in the env.d.ts file.

import VTable from 'vtbl';

app.component('VTable', VTable);

/// <reference types="vite/client" />

import VTable from 'vtbl';

declare module '@vue/runtime-core' {
    export interface GlobalComponents {
        VTable: ComponentPublicInstance<typeof VTable>;
    }
}

Remember that global registration should be done judiciously to avoid bloating the bundle size with unnecessary components. If you're using VTable in many places throughout your application, global registration is justified. If it's only in a few places, consider using local registration instead.