Vue 3 + TypeScript + Vite

This template should help get you started developing with Vue 3 and TypeScript in Vite. The template uses Vue 3 <script setup> SFCs, check out the script setup docs to learn more.

Learn more about the recommended Project Setup and IDE Support in the Vue Docs TypeScript Guide.

Installation

Install the @swarmakit/vue library through npm:

npm install @swarmakit/vue

Prerequisites

Node.js and npm should be installed. You can verify installation with:

node -v
npm -v 

Setting Up a Vite + Vue Project (If you haven't already)

To initialize a Vite project for Vue with TypeScript, run:

npm create vite@latest my-vue-app -- --template vue-ts

replacing my-vue-app with your project name.

Then, navigate to your project folder:

cd my-vue-app

Importing Components and Basic Usage in Vue

1. Import Components: To use a component in your Vue application, import it from the @swarmakit/vue library as shown below:

   <script setup>
       import { ComponentName } from '@swarmakit/vue'
   </script>

2. Example Usage in your Vue Template: Use the imported component within your Vue template:

   <template>
        <ComponentName :prop1='value' />
   <template>

Available Components: Swarmakit Vue includes a vast library of components. See the full list in the components folder on GitHub.