mirror of
				https://github.com/lingble/chatwoot.git
				synced 2025-11-04 04:57:51 +00:00 
			
		
		
		
	# Pull Request Template ## Description This PR adds new eslint rules to the code base. **Error rules** | Rule name | Type | Files updated | | ----------------- | --- | - | | `vue/block-order` | error | ✅ | | `vue/component-name-in-template-casing` | error | ✅ | | `vue/component-options-name-casing` | error | ✅ | | `vue/custom-event-name-casing` | error | ✅ | | `vue/define-emits-declaration` | error | ✅ | | `vue/no-unused-properties` | error | ✅ | | `vue/define-macros-order` | error | ✅ | | `vue/define-props-declaration` | error | ✅ | | `vue/match-component-import-name` | error | ✅ | | `vue/next-tick-style` | error | ✅ | | `vue/no-bare-strings-in-template` | error | ✅ | | `vue/no-empty-component-block` | error | ✅ | | `vue/no-multiple-objects-in-class` | error | ✅ | | `vue/no-required-prop-with-default` | error | ✅ | | `vue/no-static-inline-styles` | error | ✅ | | `vue/no-template-target-blank` | error | ✅ | | `vue/no-this-in-before-route-enter` | error | ✅ | | `vue/no-undef-components` | error | ✅ | | `vue/no-unused-emit-declarations` | error | ✅ | | `vue/no-unused-refs` | error | ✅ | | `vue/no-use-v-else-with-v-for` | error | ✅ | | `vue/no-useless-v-bind` | error | ✅ | | `vue/no-v-text` | error | ✅ | | `vue/padding-line-between-blocks` | error | ✅ | | ~`vue/prefer-prop-type-boolean-first`~ | ~error~ | ❌ (removed this rule, cause a bug in displaying custom attributes) | | `vue/prefer-separate-static-class` | error | ✅ | | `vue/prefer-true-attribute-shorthand` | error | ✅ | | `vue/require-explicit-slots` | error | ✅ | | `vue/require-macro-variable-name` | error | ✅ | **Warn rules** | Rule name | Type | Files updated | | ---- | ------------- | ------------- | | `vue/no-root-v-if` | warn | ❎ | Fixes https://linear.app/chatwoot/issue/CW-3492/vue-eslint-rules ## Type of change - [x] New feature (non-breaking change which adds functionality) ## 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: Fayaz Ahmed <fayazara@gmail.com> Co-authored-by: Muhsin Keloth <muhsinkeramam@gmail.com> Co-authored-by: Shivam Mishra <scm.mymail@gmail.com> Co-authored-by: Pranav <pranav@chatwoot.com>
		
			
				
	
	
		
			165 lines
		
	
	
		
			4.0 KiB
		
	
	
	
		
			Vue
		
	
	
	
	
	
			
		
		
	
	
			165 lines
		
	
	
		
			4.0 KiB
		
	
	
	
		
			Vue
		
	
	
	
	
	
<script>
 | 
						|
import {
 | 
						|
  appendSignature,
 | 
						|
  removeSignature,
 | 
						|
  extractTextFromMarkdown,
 | 
						|
} from 'dashboard/helper/editorHelper';
 | 
						|
import { createTypingIndicator } from '@chatwoot/utils';
 | 
						|
 | 
						|
const TYPING_INDICATOR_IDLE_TIME = 4000;
 | 
						|
export default {
 | 
						|
  props: {
 | 
						|
    placeholder: {
 | 
						|
      type: String,
 | 
						|
      default: '',
 | 
						|
    },
 | 
						|
    value: {
 | 
						|
      type: String,
 | 
						|
      default: '',
 | 
						|
    },
 | 
						|
    minHeight: {
 | 
						|
      type: Number,
 | 
						|
      default: 2,
 | 
						|
    },
 | 
						|
    signature: {
 | 
						|
      type: String,
 | 
						|
      default: '',
 | 
						|
    },
 | 
						|
    rows: {
 | 
						|
      type: Number,
 | 
						|
      default: 2,
 | 
						|
    },
 | 
						|
    // add this as a prop, so that we won't have to add useUISettings
 | 
						|
    sendWithSignature: {
 | 
						|
      type: Boolean,
 | 
						|
      default: false,
 | 
						|
    },
 | 
						|
    // allowSignature is a kill switch, ensuring no signature methods are triggered except when this flag is true
 | 
						|
    allowSignature: {
 | 
						|
      type: Boolean,
 | 
						|
      default: false,
 | 
						|
    },
 | 
						|
  },
 | 
						|
  data() {
 | 
						|
    return {
 | 
						|
      typingIndicator: createTypingIndicator(
 | 
						|
        () => {
 | 
						|
          this.$emit('typingOn');
 | 
						|
        },
 | 
						|
        () => {
 | 
						|
          this.$emit('typingOff');
 | 
						|
        },
 | 
						|
        TYPING_INDICATOR_IDLE_TIME
 | 
						|
      ),
 | 
						|
    };
 | 
						|
  },
 | 
						|
  computed: {
 | 
						|
    cleanedSignature() {
 | 
						|
      // clean the signature, this will ensure that we don't have
 | 
						|
      // any markdown formatted text in the signature
 | 
						|
      return extractTextFromMarkdown(this.signature);
 | 
						|
    },
 | 
						|
  },
 | 
						|
  watch: {
 | 
						|
    value() {
 | 
						|
      this.resizeTextarea();
 | 
						|
      // 🚨 watch triggers every time the value is changed, we cannot set this to focus then
 | 
						|
      // when this runs, it sets the cursor to the end of the body, ignoring the signature
 | 
						|
      // Suppose if someone manually set the cursor to the middle of the body
 | 
						|
      // and starts typing, the cursor will be set to the end of the body
 | 
						|
      // A surprise cursor jump? Definitely not user-friendly.
 | 
						|
      if (document.activeElement !== this.$refs.textarea) {
 | 
						|
        this.$nextTick(() => {
 | 
						|
          this.setCursor();
 | 
						|
        });
 | 
						|
      }
 | 
						|
    },
 | 
						|
    sendWithSignature(newValue) {
 | 
						|
      if (this.allowSignature) {
 | 
						|
        this.toggleSignatureInEditor(newValue);
 | 
						|
      }
 | 
						|
    },
 | 
						|
  },
 | 
						|
  mounted() {
 | 
						|
    this.$nextTick(() => {
 | 
						|
      if (this.value) {
 | 
						|
        this.resizeTextarea();
 | 
						|
        this.setCursor();
 | 
						|
      } else {
 | 
						|
        this.focus();
 | 
						|
      }
 | 
						|
    });
 | 
						|
  },
 | 
						|
  methods: {
 | 
						|
    resizeTextarea() {
 | 
						|
      this.$el.style.height = 'auto';
 | 
						|
      if (!this.value) {
 | 
						|
        this.$el.style.height = `${this.minHeight}rem`;
 | 
						|
      } else {
 | 
						|
        this.$el.style.height = `${this.$el.scrollHeight}px`;
 | 
						|
      }
 | 
						|
    },
 | 
						|
    // The toggleSignatureInEditor gets the new value from the
 | 
						|
    // watcher, this means that if the value is true, the signature
 | 
						|
    // is supposed to be added, else we remove it.
 | 
						|
    toggleSignatureInEditor(signatureEnabled) {
 | 
						|
      const valueWithSignature = signatureEnabled
 | 
						|
        ? appendSignature(this.value, this.cleanedSignature)
 | 
						|
        : removeSignature(this.value, this.cleanedSignature);
 | 
						|
 | 
						|
      this.$emit('input', valueWithSignature);
 | 
						|
 | 
						|
      this.$nextTick(() => {
 | 
						|
        this.resizeTextarea();
 | 
						|
        this.setCursor();
 | 
						|
      });
 | 
						|
    },
 | 
						|
    setCursor() {
 | 
						|
      const bodyWithoutSignature = removeSignature(
 | 
						|
        this.value,
 | 
						|
        this.cleanedSignature
 | 
						|
      );
 | 
						|
 | 
						|
      // only trim at end, so if there are spaces at the start, those are not removed
 | 
						|
      const bodyEndsAt = bodyWithoutSignature.trimEnd().length;
 | 
						|
      const textarea = this.$refs.textarea;
 | 
						|
 | 
						|
      if (textarea) {
 | 
						|
        textarea.focus();
 | 
						|
        textarea.setSelectionRange(bodyEndsAt, bodyEndsAt);
 | 
						|
      }
 | 
						|
    },
 | 
						|
    onInput(event) {
 | 
						|
      this.$emit('input', event.target.value);
 | 
						|
      this.resizeTextarea();
 | 
						|
    },
 | 
						|
    onKeyup() {
 | 
						|
      this.typingIndicator.start();
 | 
						|
    },
 | 
						|
    onBlur() {
 | 
						|
      this.typingIndicator.stop();
 | 
						|
      this.$emit('blur');
 | 
						|
    },
 | 
						|
    onFocus() {
 | 
						|
      this.$emit('focus');
 | 
						|
    },
 | 
						|
    focus() {
 | 
						|
      if (this.$refs.textarea) this.$refs.textarea.focus();
 | 
						|
    },
 | 
						|
  },
 | 
						|
};
 | 
						|
</script>
 | 
						|
 | 
						|
<template>
 | 
						|
  <textarea
 | 
						|
    ref="textarea"
 | 
						|
    :placeholder="placeholder"
 | 
						|
    :rows="rows"
 | 
						|
    :value="value"
 | 
						|
    @input="onInput"
 | 
						|
    @focus="onFocus"
 | 
						|
    @keyup="onKeyup"
 | 
						|
    @blur="onBlur"
 | 
						|
  />
 | 
						|
</template>
 |