Skip to main content

Installation Guide

Installation

npm

npm install @bdky/aaas-pilot-kit-vue3-widget

yarn

yarn add @bdky/aaas-pilot-kit-vue3-widget

pnpm

pnpm add @bdky/aaas-pilot-kit-vue3-widget

Dependency Notes

Widget component library depends on following peer dependencies:

DependencyVersion RequirementDescription
vue>=3.3.0Vue 3 core
@bdky/aaas-pilot-kit-vue3>=1.0.0Underlying SDK (automatically installed)
About Underlying SDK

@bdky/aaas-pilot-kit-vue3 will be automatically installed as a Widget dependency, you don't need to install it separately. But if you need to directly use underlying composables, you can re-export from the Widget package:

<script setup lang="ts">
// Import underlying composables from Widget package
import {
useAaaSPilotKit,
useAaaSPilotKitEvents,
useConversationList
} from '@bdky/aaas-pilot-kit-vue3-widget';
</script>

Style Import

Important

Widget components require manual import of style files to render correctly:

import '@bdky/aaas-pilot-kit-vue3-widget/styles.css';

TypeScript Support

Widget component library is written in TypeScript, providing complete type definitions:

import type {
IPilotKitProps,
IPilotKitRef,
IConversationListProps,
IControlPanelProps,
VariantType
} from '@bdky/aaas-pilot-kit-vue3-widget';

Browser Compatibility

BrowserMinimum Version
Chrome74+
Firefox90+
Safari14.1+
Edge79+
iOS Safari14.1+
Android Chrome74+

Next Steps

  • Quick Start - Get complete example running in 5 minutes