@revrag-ai/embed-react
v1.4.3
Published
React/Next.js library for Revrag AI assistant widget
Downloads
339
Maintainers
Readme
@revrag-ai/embed-react
React/Next.js library for integrating Revrag AI assistant widget into your application.
Installation
npm install @revrag-ai/embed-reactQuick Start
import { EmbedProvider, EmbedButton } from '@revrag-ai/embed-react';
function App() {
return (
<EmbedProvider
apiKey="your-api-key"
agentId="your-agent-id"
>
<EmbedButton />
{/* Your app content */}
</EmbedProvider>
);
}API Reference
Components
EmbedProvider- Context provider for the SDKEmbedButton- The AI widget button component
Hooks
useInitialize- Hook for SDK initializationuseEmbed- Hook to access embed context
Functions
embedEvent- Function to track custom eventsEventKeys- Event key constants
Types
EmbedContextType- Type for embed contextEmbedButtonDelayPolicy- Button delay policy configurationEmbedButtonContinuity- Button continuity settingsEmbedButtonGroupConfig- Button group configurationEmbedButtonVisibilityConfig- Button visibility settingsEmbedButtonPosition- Button position configurationUseSDKInitReturn- Return type for useInitialize hookEventPayload- Event payload typeEventKey- Event key typeCustomEventData- Custom event data typeCustomEventPayload- Custom event payload typeSDKConfig- SDK configuration type
License
MIT
Repository
https://github.com/revrag-ai/embed-react
