@navieo/react
v1.2.0
Published
AI-powered contextual site guide SDK for React
Maintainers
Readme
@navieo/react
AI-powered contextual site guide SDK for React and Next.js.
Installation
npm install @navieo/reactQuick Start
React
import { NavieoProvider, ChatWidget } from "@navieo/react";
function App() {
return (
<NavieoProvider currentRoute={window.location.pathname}>
<ChatWidget />
{/* your app */}
</NavieoProvider>
);
}Next.js
import { NavieoNextProvider } from "@navieo/react/next";
export default function Layout({ children }) {
return (
<NavieoNextProvider>
{children}
</NavieoNextProvider>
);
}The Next.js provider automatically handles route detection and navigation.
Exports
| Export | Description |
|--------|-------------|
| NavieoProvider | Context provider with tour and chat state management |
| ChatWidget | Built-in floating chat widget |
| useNavieo | Hook to access tour/chat state and actions |
| useTourRenderer | Hook for custom tour rendering with driver.js |
| NavieoNextProvider | Next.js wrapper (from @navieo/react/next) |
Requirements
- React 18+ or 19+
- Next.js 14+ (optional, for
@navieo/react/next) - Node.js >= 18
License
MIT
