@jarve/feature-requester
v0.2.2
Published
Feature request widget for Next.js apps. Requests flow to JARVE Agency dashboard.
Readme
@jarve/feature-requester
Feature request widget for React / Next.js apps. Requests flow to your JARVE Agency dashboard.
How it works
- A floating lightbulb icon appears in the bottom-left corner of your app (sibling-aware — auto-stacks with other @jarve widgets).
- Click it to open a small assistant.
- The assistant interviews the user about their idea and impact.
- The structured feature request is sent to your JARVE Agency dashboard.
Setup
1. Register your site
In your JARVE admin dashboard at /admin/feature-requests/sites:
- Click Add Site
- Enter your site name and color
- Click Generate API Key
- Copy the API key (starts with
frk_)
2. Install
pnpm add @jarve/feature-requester
# or
npm install @jarve/feature-requester3. Add Tailwind content path
The widget uses Tailwind CSS utility classes. Add the package to your Tailwind configuration so the classes aren't purged.
Tailwind v4 (add @source in your CSS file):
@source '../node_modules/@jarve/feature-requester/dist';Tailwind v3 (add to content in tailwind.config.(js|ts)):
content: [
// ...
'./node_modules/@jarve/feature-requester/dist/**/*.{js,mjs}',
]4. Wrap your layout
// app/layout.tsx
import { JarveFeatureRequester } from '@jarve/feature-requester'
export default function RootLayout({ children }: { children: React.ReactNode }) {
return (
<html>
<body>
<JarveFeatureRequester
apiUrl="https://www.jarve.com.au/api/feature-requester/external"
apiKey="frk_your_api_key_here"
user={{ name: 'James', email: '[email protected]' }}
>
{children}
</JarveFeatureRequester>
</body>
</html>
)
}5. Done!
Click the lightbulb icon (bottom-right) to submit feature ideas. They'll appear in your JARVE Agency dashboard.
Props
| Prop | Type | Required | Description |
| ---------------- | --------------------------------- | -------- | ------------------------------------------------------------------------------------- |
| apiUrl | string | Yes | Base URL for the external feature requester API |
| apiKey | string | Yes | Your site's API key (starts with frk_) |
| user | { name: string, email: string } | No | User info. If omitted, the AI may ask during conversation |
| buttonPosition | 'left' \| 'right' | No | Floating button position. Default: 'left'. Sibling-aware with other @jarve widgets. |
| children | React.ReactNode | Yes | Your app content |
What gets captured
- Page URL and section identifier (if available)
- Device type, browser, OS, viewport size
- AI conversation transcript
- Structured feature request (summary, description, use case, impact, priority, category)
Requirements
- React 18+
- Tailwind CSS (v3 or v4)
- Next.js recommended but not required