Installation Guide
Installation
npm
npm install @bdky/aaas-pilot-kit-react-widget
yarn
yarn add @bdky/aaas-pilot-kit-react-widget
pnpm
pnpm add @bdky/aaas-pilot-kit-react-widget
Dependency Notes
Widget component library depends on the following peer dependencies:
| Dependency | Version Requirement | Description |
|---|---|---|
react | >=17.0.0 | React core |
react-dom | >=17.0.0 | React DOM |
@bdky/aaas-pilot-kit-react | >=1.0.0 | Underlying SDK (automatically installed) |
About Underlying SDK
@bdky/aaas-pilot-kit-react will be automatically installed as Widget's dependency, you don't need to install it separately. But if you need to directly use underlying Hooks, you can re-export from Widget package:
// Import underlying Hooks from Widget package
import {
useAaaSPilotKit,
useAaaSPilotKitEvents,
useConversationList
} from '@bdky/aaas-pilot-kit-react-widget';
Style Import
Important
Widget components require manual import of style files for proper rendering:
import '@bdky/aaas-pilot-kit-react-widget/styles.css';
TypeScript Support
Widget component library is written in TypeScript and provides complete type definitions:
import type {
IPilotKitProps,
IPilotKitRef,
IConversationListProps,
IControlPanelProps,
VariantType
} from '@bdky/aaas-pilot-kit-react-widget';
Browser Compatibility
| Browser | Minimum Version |
|---|---|
| Chrome | 74+ |
| Firefox | 90+ |
| Safari | 14.1+ |
| Edge | 79+ |
| iOS Safari | 14.1+ |
| Android Chrome | 74+ |
Next Steps
- Quick Start - 5 minutes to build complete example