mirror of
				https://github.com/lingble/chatwoot.git
				synced 2025-11-04 13:07:55 +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>
		
	
		
			
				
	
	
		
			145 lines
		
	
	
		
			3.8 KiB
		
	
	
	
		
			Vue
		
	
	
	
	
	
			
		
		
	
	
			145 lines
		
	
	
		
			3.8 KiB
		
	
	
	
		
			Vue
		
	
	
	
	
	
<script>
 | 
						|
import Banner from '../Banner.vue';
 | 
						|
import Branding from 'shared/components/Branding.vue';
 | 
						|
import ChatHeader from '../ChatHeader.vue';
 | 
						|
import ChatHeaderExpanded from '../ChatHeaderExpanded.vue';
 | 
						|
import configMixin from '../../mixins/configMixin';
 | 
						|
import { mapGetters } from 'vuex';
 | 
						|
import { IFrameHelper } from 'widget/helpers/utils';
 | 
						|
 | 
						|
export default {
 | 
						|
  components: {
 | 
						|
    Banner,
 | 
						|
    Branding,
 | 
						|
    ChatHeader,
 | 
						|
    ChatHeaderExpanded,
 | 
						|
  },
 | 
						|
  mixins: [configMixin],
 | 
						|
  data() {
 | 
						|
    return {
 | 
						|
      showPopoutButton: false,
 | 
						|
      scrollPosition: 0,
 | 
						|
      ticking: true,
 | 
						|
      disableBranding: window.chatwootWebChannel.disableBranding || false,
 | 
						|
      requestID: null,
 | 
						|
    };
 | 
						|
  },
 | 
						|
  computed: {
 | 
						|
    ...mapGetters({
 | 
						|
      appConfig: 'appConfig/getAppConfig',
 | 
						|
      availableAgents: 'agent/availableAgents',
 | 
						|
    }),
 | 
						|
    portal() {
 | 
						|
      return window.chatwootWebChannel.portal;
 | 
						|
    },
 | 
						|
    isHeaderCollapsed() {
 | 
						|
      if (!this.hasIntroText) {
 | 
						|
        return true;
 | 
						|
      }
 | 
						|
      return !this.isOnHomeView;
 | 
						|
    },
 | 
						|
    hasIntroText() {
 | 
						|
      return (
 | 
						|
        this.channelConfig.welcomeTitle || this.channelConfig.welcomeTagline
 | 
						|
      );
 | 
						|
    },
 | 
						|
    showBackButton() {
 | 
						|
      return ['article-viewer', 'messages', 'prechat-form'].includes(
 | 
						|
        this.$route.name
 | 
						|
      );
 | 
						|
    },
 | 
						|
    isOnArticleViewer() {
 | 
						|
      return ['article-viewer'].includes(this.$route.name);
 | 
						|
    },
 | 
						|
    isOnHomeView() {
 | 
						|
      return ['home'].includes(this.$route.name);
 | 
						|
    },
 | 
						|
    opacityClass() {
 | 
						|
      if (this.isHeaderCollapsed) {
 | 
						|
        return {};
 | 
						|
      }
 | 
						|
      if (this.scrollPosition > 30) {
 | 
						|
        return { 'opacity-30': true };
 | 
						|
      }
 | 
						|
      if (this.scrollPosition > 25) {
 | 
						|
        return { 'opacity-40': true };
 | 
						|
      }
 | 
						|
      if (this.scrollPosition > 20) {
 | 
						|
        return { 'opacity-60': true };
 | 
						|
      }
 | 
						|
      if (this.scrollPosition > 15) {
 | 
						|
        return { 'opacity-80': true };
 | 
						|
      }
 | 
						|
      if (this.scrollPosition > 10) {
 | 
						|
        return { 'opacity-90': true };
 | 
						|
      }
 | 
						|
      return {};
 | 
						|
    },
 | 
						|
  },
 | 
						|
  mounted() {
 | 
						|
    this.$el.addEventListener('scroll', this.updateScrollPosition);
 | 
						|
  },
 | 
						|
  unmounted() {
 | 
						|
    this.$el.removeEventListener('scroll', this.updateScrollPosition);
 | 
						|
    cancelAnimationFrame(this.requestID);
 | 
						|
  },
 | 
						|
  methods: {
 | 
						|
    closeWindow() {
 | 
						|
      IFrameHelper.sendMessage({ event: 'closeWindow' });
 | 
						|
    },
 | 
						|
    updateScrollPosition(event) {
 | 
						|
      this.scrollPosition = event.target.scrollTop;
 | 
						|
      if (!this.ticking) {
 | 
						|
        this.requestID = window.requestAnimationFrame(() => {
 | 
						|
          this.ticking = false;
 | 
						|
        });
 | 
						|
 | 
						|
        this.ticking = true;
 | 
						|
      }
 | 
						|
    },
 | 
						|
  },
 | 
						|
};
 | 
						|
</script>
 | 
						|
 | 
						|
<template>
 | 
						|
  <div
 | 
						|
    class="w-full h-full bg-n-slate-2 dark:bg-n-solid-1"
 | 
						|
    :class="{ 'overflow-auto': isOnHomeView }"
 | 
						|
    @keydown.esc="closeWindow"
 | 
						|
  >
 | 
						|
    <div class="relative flex flex-col h-full">
 | 
						|
      <div
 | 
						|
        :class="{
 | 
						|
          expanded: !isHeaderCollapsed,
 | 
						|
          collapsed: isHeaderCollapsed,
 | 
						|
          'shadow-[0_10px_15px_-16px_rgba(50,50,93,0.08),0_4px_6px_-8px_rgba(50,50,93,0.04)]':
 | 
						|
            isHeaderCollapsed,
 | 
						|
          ...opacityClass,
 | 
						|
        }"
 | 
						|
      >
 | 
						|
        <ChatHeaderExpanded
 | 
						|
          v-if="!isHeaderCollapsed"
 | 
						|
          :intro-heading="appConfig.welcomeTitle || channelConfig.welcomeTitle"
 | 
						|
          :intro-body="
 | 
						|
            appConfig.welcomeDescription || channelConfig.welcomeTagline
 | 
						|
          "
 | 
						|
          :avatar-url="channelConfig.avatarUrl"
 | 
						|
          :show-popout-button="appConfig.showPopoutButton"
 | 
						|
        />
 | 
						|
        <ChatHeader
 | 
						|
          v-if="isHeaderCollapsed"
 | 
						|
          :title="channelConfig.websiteName"
 | 
						|
          :avatar-url="channelConfig.avatarUrl"
 | 
						|
          :show-popout-button="appConfig.showPopoutButton"
 | 
						|
          :available-agents="availableAgents"
 | 
						|
          :show-back-button="showBackButton"
 | 
						|
        />
 | 
						|
      </div>
 | 
						|
      <Banner />
 | 
						|
      <router-view />
 | 
						|
 | 
						|
      <Branding v-if="!isOnArticleViewer" :disable-branding="disableBranding" />
 | 
						|
    </div>
 | 
						|
  </div>
 | 
						|
</template>
 |