1.2.1 • Published 4 months ago

@dsb-norge/vue-feedback-dialog v1.2.1

Weekly downloads
1
License
MIT
Repository
github
Last release
4 months ago

vue-feedback-dialog

Feedback dialog for Vue/Vuetify

Demo

Icon (right bottom corner fixed):

alt text

Info screen:

alt text

Input screen:

alt text

Install

  1. Install Vuetify See documentation

  2. Install component:

npm install @dsb-norge/vue-feedback-dialog --save

Usage

Setup

Import in component (or use global):

import VueFeedbackDialog from '@dsb-norge/vue-feedback-dialog'

components: {
    VueFeedbackDialog
}

<VueFeedbackDialog
    :messages="messages"
    :options="options"
    @feedback="handleFeedback"
/>

Messages format: (optional)

      messages: [
        {
          header: 'Maintenance 23.02.20', (h5)
          info: 'Describing text' (p)
        },
        {
          header: 'Down time 10.05.20', (h5)
          info: 'Describing text' (p)
        }
      ]

Options format: (optional)

    defaultOptions: {
        text: {
            headerInfo: 'Information: ',
            headerDialog: 'Report error or suggestion: ',
            dialogLeftControlText: 'Back',
            infoLeftControlText: 'Close',
            dialogRightControlText: 'Send',
            infoRightControlText: 'Report bug',
            reporter: 'Reporter',
            reporterError: 'This field is required',
            description: 'Description...',
            descriptionError: 'This field is required',
            email: 'Email',
            emailError: 'Invalid email address'
        },
        layout: {
            color: '#34495e',
            border: '#34495e',
            background: '#FFF'
        }
    }

Options

NameTypeDefault
headerInfoStringInformation: (h4)
headerDialogStringReport error or suggestion: (h4)
dialogLeftControlTextStringBack
infoLeftControlTextStringClose
dialogRightControlTextStringSend
infoRightControlTextStringReport bug
reporterStringReporter
reporterErrorStringThis field is required
descriptionStringDescription...
descriptionErrorStringThis field is required
emailStringEmail
emailErrorStringInvalid email address
colorString#34495e
borderString#34495e
backgroundString#FFF

Props

NameTypeDescription
optionsObjectOptions object as described above
messagesArrayInfo messages to user
metaStringAdditional meta information, ie: App version, date time etc

Events

NameDescription
feedbackTriggered on send, user click send on input form

Value in feedback event:

    {
        reporter: this.reporter,
        description: this.description,
        path: window.location.href,
        email: this.email,
        meta: this.meta
    }

Feedback only mode

If no messages is provided only the feedback form will be visible.

Build:

Compile and build for production

npm run build

Publish to NPM

# Do some work...

# x.x.1 -> x.x.2
npm version patch

# x.1.0 -> x.2.0
npm version minor

# 1.0.0 -> 2.0.0
npm version major

All these will: 1. Set the version number in package.json 1. Build the plugin 1. Commit version to git and push upstream 1. Publish the plugin to NPM registry

1.2.1

4 months ago

1.2.0

9 months ago

1.1.1

1 year ago

1.1.0

2 years ago

1.0.4

3 years ago

1.0.3

3 years ago

1.0.2

3 years ago

1.0.1

3 years ago

1.0.0

3 years ago