Skip to content

Configuration

OptionTypeDefaultDescription
enabledbooleantrueEnables widget + submit API
primaryColorstring#3b82f6Launcher / primary button color
primaryTextColorstring#ffffffText on primary surfaces
modalBgColorstring#0f172aFeedback form modal background
modalTextColorstring#ffffffFeedback form modal text
annotateBgColorstring#3f3f46Annotate modal background
annotateTextColorstring#f4f4f5Annotate modal text
secondaryColorstring#1e293bLegacy fallback for modal background
buttonLayout'horizontal' | 'vertical''vertical'Launcher orientation
position.edge'left' | 'right' | 'top' | 'bottom''right'Edge the launcher hugs
position.offsetXnumber0Pixel offset on X
position.offsetYnumber0Pixel offset on Y
auth'required' | 'optional' | 'none''optional'Client auth gate
labelstring'Feedback'Launcher label
submitPathstring/api/_bugfreedback/submitNitro route
storageobject{ provider: 'none' }Screenshot storage adapter
exportobjectwebhook stubExport adapter

Peer dependency

Hosts must provide @nuxt/ui (>=3). The module declares it via moduleDependencies and bundles Lucide icons used by the toolbar.

bash
npm install @nuxt/ui
ts
export default defineNuxtConfig({
  modules: ['@nuxt/ui', '@bugfreedback/bugfreedback'],
})

CSS variables applied on the document root:

  • --bugfreedback-primary
  • --bugfreedback-secondary
  • --bugfreedback-primary-text
  • --bugfreedback-modal-bg
  • --bugfreedback-modal-text
  • --bugfreedback-annotate-bg
  • --bugfreedback-annotate-text

Released under the MIT License.