mirror of
https://github.com/lingble/chatwoot.git
synced 2025-11-03 12:37:56 +00:00
# Pull Request Template ## Description This PR introduces basic customization options for the CSAT survey: * **Display Type**: Option to use star ratings instead of emojis. * **Message Text**: Customize the survey message (up to 200 characters). * **Survey Rules**: Send surveys based on labels — trigger when a conversation has or doesn't have a specific label. Fixes https://linear.app/chatwoot/document/improve-csat-responses-a61cf30e054e ## Type of change - [x] New feature (non-breaking change which adds functionality) ## How Has This Been Tested? ### Loom videos **Website Channel (Widget)** https://www.loom.com/share/7f47836cde7940ae9d17b7997d060a18?sid=aad2ad0a-140a-4a09-8829-e01fa2e102c5 **Email Channel (Survey link)** https://www.loom.com/share/e92f4c4c0f73417ba300a25885e093ce?sid=4bb006f0-1c2a-4352-a232-8bf684e3d757 ## Checklist: - [x] My code follows the style guidelines of this project - [x] I have performed a self-review of my code - [x] I have commented on my code, particularly in hard-to-understand areas - [ ] I have made corresponding changes to the documentation - [x] My changes generate no new warnings - [x] I have added tests that prove my fix is effective or that my feature works - [x] New and existing unit tests pass locally with my changes - [ ] Any dependent changes have been merged and published in downstream modules --------- Co-authored-by: Pranav <pranavrajs@gmail.com>
211 lines
6.0 KiB
Vue
211 lines
6.0 KiB
Vue
<script>
|
|
import { useAlert } from 'dashboard/composables';
|
|
import Branding from 'shared/components/Branding.vue';
|
|
import Spinner from 'shared/components/Spinner.vue';
|
|
import Rating from 'survey/components/Rating.vue';
|
|
import Feedback from 'survey/components/Feedback.vue';
|
|
import Banner from 'survey/components/Banner.vue';
|
|
import StarRating from 'shared/components/StarRating.vue';
|
|
import { getSurveyDetails, updateSurvey } from 'survey/api/survey';
|
|
|
|
import { CSAT_DISPLAY_TYPES } from 'shared/constants/messages';
|
|
|
|
export default {
|
|
name: 'Response',
|
|
components: {
|
|
Branding,
|
|
Rating,
|
|
Spinner,
|
|
Banner,
|
|
Feedback,
|
|
StarRating,
|
|
},
|
|
data() {
|
|
return {
|
|
surveyDetails: null,
|
|
isLoading: false,
|
|
errorMessage: null,
|
|
selectedRating: null,
|
|
feedbackMessage: '',
|
|
isUpdating: false,
|
|
logo: '',
|
|
inboxName: '',
|
|
displayType: CSAT_DISPLAY_TYPES.EMOJI,
|
|
messageContent: '',
|
|
};
|
|
},
|
|
computed: {
|
|
surveyId() {
|
|
const pageURL = window.location.href;
|
|
return pageURL.substring(pageURL.lastIndexOf('/') + 1);
|
|
},
|
|
isRatingSubmitted() {
|
|
return this.surveyDetails && this.surveyDetails.rating;
|
|
},
|
|
isFeedbackSubmitted() {
|
|
return this.surveyDetails && this.surveyDetails.feedback_message;
|
|
},
|
|
isButtonDisabled() {
|
|
return !(this.selectedRating && this.feedback);
|
|
},
|
|
isEmojiType() {
|
|
return this.displayType === CSAT_DISPLAY_TYPES.EMOJI;
|
|
},
|
|
isStarType() {
|
|
return this.displayType === CSAT_DISPLAY_TYPES.STAR;
|
|
},
|
|
shouldShowBanner() {
|
|
return this.isRatingSubmitted || this.errorMessage;
|
|
},
|
|
enableFeedbackForm() {
|
|
return !this.isFeedbackSubmitted && this.isRatingSubmitted;
|
|
},
|
|
shouldShowErrorMessage() {
|
|
return !!this.errorMessage;
|
|
},
|
|
shouldShowSuccessMessage() {
|
|
return !!this.isRatingSubmitted;
|
|
},
|
|
message() {
|
|
if (this.errorMessage) {
|
|
return this.errorMessage;
|
|
}
|
|
return this.$t('SURVEY.RATING.SUCCESS_MESSAGE');
|
|
},
|
|
},
|
|
async mounted() {
|
|
this.getSurveyDetails();
|
|
},
|
|
methods: {
|
|
selectRating(rating) {
|
|
this.selectedRating = rating;
|
|
this.updateSurveyDetails();
|
|
},
|
|
sendFeedback(message) {
|
|
this.feedbackMessage = message;
|
|
this.updateSurveyDetails();
|
|
},
|
|
async getSurveyDetails() {
|
|
this.isLoading = true;
|
|
try {
|
|
const result = await getSurveyDetails({ uuid: this.surveyId });
|
|
this.logo = result.data.inbox_avatar_url;
|
|
this.inboxName = result.data.inbox_name;
|
|
this.surveyDetails = result?.data?.csat_survey_response;
|
|
this.selectedRating = this.surveyDetails?.rating;
|
|
this.feedbackMessage = this.surveyDetails?.feedback_message || '';
|
|
this.displayType = result.data.display_type || CSAT_DISPLAY_TYPES.EMOJI;
|
|
this.messageContent =
|
|
result.data.content ||
|
|
this.$t('SURVEY.DESCRIPTION', { inboxName: this.inboxName });
|
|
this.setLocale(result.data.locale);
|
|
} catch (error) {
|
|
const errorMessage = error?.response?.data?.message;
|
|
this.errorMessage = errorMessage || this.$t('SURVEY.API.ERROR_MESSAGE');
|
|
} finally {
|
|
this.isLoading = false;
|
|
}
|
|
},
|
|
async updateSurveyDetails() {
|
|
this.isUpdating = true;
|
|
try {
|
|
const data = {
|
|
message: {
|
|
submitted_values: {
|
|
csat_survey_response: {
|
|
rating: this.selectedRating,
|
|
feedback_message: this.feedbackMessage,
|
|
},
|
|
},
|
|
},
|
|
};
|
|
await updateSurvey({
|
|
uuid: this.surveyId,
|
|
data,
|
|
});
|
|
this.surveyDetails = {
|
|
rating: this.selectedRating,
|
|
feedback_message: this.feedbackMessage,
|
|
};
|
|
} catch (error) {
|
|
const errorMessage = error?.response?.data?.error;
|
|
this.errorMessage = errorMessage || this.$t('SURVEY.API.ERROR_MESSAGE');
|
|
useAlert(this.errorMessage);
|
|
} finally {
|
|
this.isUpdating = false;
|
|
}
|
|
},
|
|
setLocale(locale) {
|
|
this.$root.$i18n.locale = locale || 'en';
|
|
},
|
|
},
|
|
};
|
|
</script>
|
|
|
|
<template>
|
|
<div
|
|
v-if="isLoading"
|
|
class="flex items-center justify-center flex-1 h-full min-h-screen bg-n-background"
|
|
>
|
|
<Spinner size="" />
|
|
</div>
|
|
<div
|
|
v-else
|
|
class="flex items-center justify-center w-full h-full min-h-screen overflow-auto bg-n-background"
|
|
>
|
|
<div
|
|
class="flex flex-col w-full h-full bg-n-solid-1 rounded-lg border border-solid border-n-weak shadow-md lg:w-2/5 lg:h-auto"
|
|
>
|
|
<div class="w-full px-12 pt-12 pb-6 m-auto my-0">
|
|
<img v-if="logo" :src="logo" alt="Chatwoot logo" class="mb-6 logo" />
|
|
<p
|
|
v-if="!isRatingSubmitted"
|
|
class="mb-8 text-lg leading-relaxed text-n-slate-12"
|
|
>
|
|
{{ messageContent }}
|
|
</p>
|
|
<Banner
|
|
v-if="shouldShowBanner"
|
|
:show-success="shouldShowSuccessMessage"
|
|
:show-error="shouldShowErrorMessage"
|
|
:message="message"
|
|
/>
|
|
<label
|
|
v-if="!isRatingSubmitted"
|
|
class="mb-4 text-base font-medium text-n-slate-11"
|
|
>
|
|
{{ $t('SURVEY.RATING.LABEL') }}
|
|
</label>
|
|
<Rating
|
|
v-if="isEmojiType"
|
|
:selected-rating="selectedRating"
|
|
@select-rating="selectRating"
|
|
/>
|
|
<StarRating
|
|
v-if="isStarType"
|
|
:selected-rating="selectedRating"
|
|
:is-disabled="isRatingSubmitted"
|
|
class="[&>button>span]:text-4xl !justify-start !px-0"
|
|
@select-rating="selectRating"
|
|
/>
|
|
<Feedback
|
|
v-if="enableFeedbackForm"
|
|
:is-updating="isUpdating"
|
|
:is-button-disabled="isButtonDisabled"
|
|
:selected-rating="selectedRating"
|
|
@send-feedback="sendFeedback"
|
|
/>
|
|
</div>
|
|
<div class="mb-3">
|
|
<Branding />
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</template>
|
|
|
|
<style scoped lang="scss">
|
|
.logo {
|
|
max-height: 3rem;
|
|
}
|
|
</style>
|