Getting Started

Installation

pnpm

pnpm add @lehoczky/vue-termynal

npm

npm i @lehoczky/vue-termynal

Simple example

First, import and register the plugin in your main.ts file:

main.ts

import App from "./App.vue"
import VueTermynalPlugin from "@lehoczky/vue-termynal"

createApp(App).use(VueTermynalPlugin).mount("#app")

Alternatively you can import the components directly:

App.vue

<template>
  <v-termynal>
    <vt-input>pip install spaCy</vt-input>
    <vt-progress />
    <vt-text>Successfully installed spacy</vt-text>
  </v-termynal>
</template>

<script setup lang="ts">
import {
  VTermynal,
  VtInput,
  VtProgress,
  VtText,
  VtSpinner,
} from "@lehoczky/vue-termynal"
</script>

pip install spaCySuccessfully installed spacy

As you can see each vt-input, vt-progress, vt-text component inside <v-termynal> will be animated and shown line by line.

You will see how to customize these components in the following pages.