mirror of
				https://github.com/lingble/chatwoot.git
				synced 2025-11-04 04:57:51 +00:00 
			
		
		
		
	# Pull Request Template
## Description
This PR allows users to dynamically pass custom welcome and availability
messages, along with UI feature toggles, via `window.chatwootSettings`.
If any of the following settings are provided, the widget will use them;
otherwise, it falls back to default behavior.
**New options:**
```
window.chatwootSettings = {
  welcomeTitle: 'Need help?',                        // Custom widget title
  welcomeDescription: 'We’re here to support you.',        // Subtitle in the header
  availableMessage: 'We’re online and ready to chat!', // Shown when team is online
  unavailableMessage: 'We’re currently offline.',      // Shown when team is unavailable
  enableFileUpload: true,          // Enable file attachments
  enableEmojiPicker: true,         // Enable emoji picker in chat input
  enableEndConversation: true     // Allow users to end the conversation
}
```
Fixes
https://linear.app/chatwoot/issue/CW-4589/add-options-to-windowchatwootsettings
## Type of change
- [x] New feature (non-breaking change which adds functionality)
## How Has This Been Tested?
### Loom video
https://www.loom.com/share/413fc4aa59384366b071450bd19d1bf8?sid=ff30fb4c-267c-4beb-80ab-d6f583aa960d
## Checklist:
- [x] My code follows the style guidelines of this project
- [x] I have performed a self-review of my code
- [ ] 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
- [ ] 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: Muhsin Keloth <muhsinkeramam@gmail.com>
		
	
		
			
				
	
	
		
			162 lines
		
	
	
		
			4.5 KiB
		
	
	
	
		
			Vue
		
	
	
		
			Executable File
		
	
	
	
	
			
		
		
	
	
			162 lines
		
	
	
		
			4.5 KiB
		
	
	
	
		
			Vue
		
	
	
		
			Executable File
		
	
	
	
	
<script>
 | 
						|
import FileUpload from 'vue-upload-component';
 | 
						|
import Spinner from 'shared/components/Spinner.vue';
 | 
						|
import { checkFileSizeLimit } from 'shared/helpers/FileHelper';
 | 
						|
import {
 | 
						|
  MAXIMUM_FILE_UPLOAD_SIZE,
 | 
						|
  ALLOWED_FILE_TYPES,
 | 
						|
} from 'shared/constants/messages';
 | 
						|
import { BUS_EVENTS } from 'shared/constants/busEvents';
 | 
						|
import FluentIcon from 'shared/components/FluentIcon/Index.vue';
 | 
						|
import { DirectUpload } from 'activestorage';
 | 
						|
import { mapGetters } from 'vuex';
 | 
						|
import { emitter } from 'shared/helpers/mitt';
 | 
						|
 | 
						|
export default {
 | 
						|
  components: { FluentIcon, FileUpload, Spinner },
 | 
						|
  props: {
 | 
						|
    onAttach: {
 | 
						|
      type: Function,
 | 
						|
      default: () => {},
 | 
						|
    },
 | 
						|
  },
 | 
						|
  data() {
 | 
						|
    return { isUploading: false };
 | 
						|
  },
 | 
						|
  computed: {
 | 
						|
    ...mapGetters({
 | 
						|
      globalConfig: 'globalConfig/get',
 | 
						|
      shouldShowFilePicker: 'appConfig/getShouldShowFilePicker',
 | 
						|
    }),
 | 
						|
    fileUploadSizeLimit() {
 | 
						|
      return MAXIMUM_FILE_UPLOAD_SIZE;
 | 
						|
    },
 | 
						|
    allowedFileTypes() {
 | 
						|
      return ALLOWED_FILE_TYPES;
 | 
						|
    },
 | 
						|
  },
 | 
						|
  mounted() {
 | 
						|
    document.addEventListener('paste', this.handleClipboardPaste);
 | 
						|
  },
 | 
						|
  unmounted() {
 | 
						|
    document.removeEventListener('paste', this.handleClipboardPaste);
 | 
						|
  },
 | 
						|
  methods: {
 | 
						|
    handleClipboardPaste(e) {
 | 
						|
      // If file picker is not enabled, do not allow paste
 | 
						|
      if (!this.shouldShowFilePicker) return;
 | 
						|
 | 
						|
      const items = (e.clipboardData || e.originalEvent.clipboardData).items;
 | 
						|
      // items is a DataTransferItemList object which does not have forEach method
 | 
						|
      const itemsArray = Array.from(items);
 | 
						|
      itemsArray.forEach(item => {
 | 
						|
        if (item.kind === 'file') {
 | 
						|
          e.preventDefault();
 | 
						|
          const file = item.getAsFile();
 | 
						|
          this.$refs.upload.add(file);
 | 
						|
        }
 | 
						|
      });
 | 
						|
    },
 | 
						|
    getFileType(fileType) {
 | 
						|
      return fileType.includes('image') ? 'image' : 'file';
 | 
						|
    },
 | 
						|
    async onFileUpload(file) {
 | 
						|
      if (this.globalConfig.directUploadsEnabled) {
 | 
						|
        await this.onDirectFileUpload(file);
 | 
						|
      } else {
 | 
						|
        await this.onIndirectFileUpload(file);
 | 
						|
      }
 | 
						|
    },
 | 
						|
    async onDirectFileUpload(file) {
 | 
						|
      if (!file) {
 | 
						|
        return;
 | 
						|
      }
 | 
						|
      this.isUploading = true;
 | 
						|
      try {
 | 
						|
        if (checkFileSizeLimit(file, MAXIMUM_FILE_UPLOAD_SIZE)) {
 | 
						|
          const { websiteToken } = window.chatwootWebChannel;
 | 
						|
          const upload = new DirectUpload(
 | 
						|
            file.file,
 | 
						|
            `/api/v1/widget/direct_uploads?website_token=${websiteToken}`,
 | 
						|
            {
 | 
						|
              directUploadWillCreateBlobWithXHR: xhr => {
 | 
						|
                xhr.setRequestHeader('X-Auth-Token', window.authToken);
 | 
						|
              },
 | 
						|
            }
 | 
						|
          );
 | 
						|
 | 
						|
          upload.create((error, blob) => {
 | 
						|
            if (error) {
 | 
						|
              emitter.emit(BUS_EVENTS.SHOW_ALERT, {
 | 
						|
                message: error,
 | 
						|
              });
 | 
						|
            } else {
 | 
						|
              this.onAttach({
 | 
						|
                file: blob.signed_id,
 | 
						|
                ...this.getLocalFileAttributes(file),
 | 
						|
              });
 | 
						|
            }
 | 
						|
          });
 | 
						|
        } else {
 | 
						|
          emitter.emit(BUS_EVENTS.SHOW_ALERT, {
 | 
						|
            message: this.$t('FILE_SIZE_LIMIT', {
 | 
						|
              MAXIMUM_FILE_UPLOAD_SIZE: this.fileUploadSizeLimit,
 | 
						|
            }),
 | 
						|
          });
 | 
						|
        }
 | 
						|
      } catch (error) {
 | 
						|
        // Error
 | 
						|
      }
 | 
						|
      this.isUploading = false;
 | 
						|
    },
 | 
						|
    async onIndirectFileUpload(file) {
 | 
						|
      if (!file) {
 | 
						|
        return;
 | 
						|
      }
 | 
						|
      this.isUploading = true;
 | 
						|
      try {
 | 
						|
        if (checkFileSizeLimit(file, MAXIMUM_FILE_UPLOAD_SIZE)) {
 | 
						|
          await this.onAttach({
 | 
						|
            file: file.file,
 | 
						|
            ...this.getLocalFileAttributes(file),
 | 
						|
          });
 | 
						|
        } else {
 | 
						|
          emitter.emit(BUS_EVENTS.SHOW_ALERT, {
 | 
						|
            message: this.$t('FILE_SIZE_LIMIT', {
 | 
						|
              MAXIMUM_FILE_UPLOAD_SIZE: this.fileUploadSizeLimit,
 | 
						|
            }),
 | 
						|
          });
 | 
						|
        }
 | 
						|
      } catch (error) {
 | 
						|
        // Error
 | 
						|
      }
 | 
						|
      this.isUploading = false;
 | 
						|
    },
 | 
						|
    getLocalFileAttributes(file) {
 | 
						|
      return {
 | 
						|
        thumbUrl: window.URL.createObjectURL(file.file),
 | 
						|
        fileType: this.getFileType(file.type),
 | 
						|
      };
 | 
						|
    },
 | 
						|
  },
 | 
						|
};
 | 
						|
</script>
 | 
						|
 | 
						|
<template>
 | 
						|
  <FileUpload
 | 
						|
    ref="upload"
 | 
						|
    :size="4096 * 2048"
 | 
						|
    :accept="allowedFileTypes"
 | 
						|
    :data="{
 | 
						|
      direct_upload_url: '/api/v1/widget/direct_uploads',
 | 
						|
      direct_upload: true,
 | 
						|
    }"
 | 
						|
    @input-file="onFileUpload"
 | 
						|
  >
 | 
						|
    <button class="min-h-8 min-w-8 flex items-center justify-center">
 | 
						|
      <FluentIcon v-if="!isUploading.image" icon="attach" />
 | 
						|
      <Spinner v-if="isUploading" size="small" />
 | 
						|
    </button>
 | 
						|
  </FileUpload>
 | 
						|
</template>
 |