Voyage Feedback Widget SDK - Collect user feedback with ease
npm install @voyage-sdk/coreFeedback widget SDK for collecting user feedback. Help your users send feedback directly to the maker.
``bash`
npm install @voyage-sdk/core
Or via CDN:
`html`
> Note: Styles are automatically injected. No CSS import required.
`html`
`tsx
import { useEffect } from 'react'
import Voyage from '@voyage-sdk/core'
function App() {
useEffect(() => {
Voyage.init({
sdkKey: 'your-sdk-key-here'
})
}, [])
return
$3
`vue
`$3
`svelte
`Configuration
`javascript
Voyage.init({
// Required: Your SDK key from the dashboard
sdkKey: 'your-sdk-key-here', // Optional: Control where the widget appears
include: ['/dashboard/', '/app/'], // Only show on these paths
exclude: ['/admin/*', '/login'] // Hide on these paths
})
`> Note: Theme settings (color, position, labels) are configured from the dashboard.
API
$3
Initialize the SDK with your configuration.
$3
Show the feedback widget button.
$3
Hide the feedback widget button.
$3
Open the feedback modal.
$3
Close the feedback modal.
$3
Returns
true if the modal is currently open.$3
Returns
true if the widget button is visible.$3
Remove the widget from the page and clean up.
$3
Fetch the latest widget configuration from the server.
Path Matching
Use
include and exclude to control where the widget appears:`javascript
Voyage.init({
sdkKey: 'your-sdk-key', // Widget only appears on paths starting with /app/
include: ['/app/*'],
// Or exclude specific paths
exclude: ['/admin/*', '/checkout']
})
`-
include takes priority over exclude
- Use / for wildcard matching (e.g., /admin/ matches /admin/users)
- Exact paths match exactly (e.g., /login only matches /login`)1. Sign up at morphPRD.io
2. Create a new project
3. Copy your SDK key from the project settings
MIT