# Pull Request Template ## Description 1. This PR is an enhancement to https://github.com/chatwoot/chatwoot/pull/13045 It strips unsupported formatting from **message signatures** based on each channel’s formatting capabilities defined in the `FORMATTING` config 2. Remove usage of plain editor in Compose new conversation modal Only the following signature elements are considered: <strong>bold (<code inline="">strong</code>), italic (<code inline="">em</code>), links (<code inline="">link</code>), images (<code inline="">image</code>)</strong>.</p> Any formatting not supported by the target channel is automatically removed before the signature is appended. <h3>Channel-wise Signature Formatting Support</h3> Channel | Keeps in Signature | Strips from Signature -- | -- | -- Email | bold, italic, links, images | — WebWidget | bold, italic, links, images | — API | bold, italic | links, images WhatsApp | bold, italic | links, images Telegram | bold, italic, links | images Facebook | bold, italic | links, images Instagram | bold, italic | links, images Line | bold, italic | links, images SMS | — | everything Twilio SMS | — | everything Twitter/X | — | everything <hr> <h3>📝 Note</h3> <blockquote> <p>Message signatures only support <strong>bold, italic, links, and images</strong>.<br> Other formatting options available in the editor (lists, code blocks, strike-through, etc.) do <strong>not apply</strong> to signatures and are ignored.</p> </blockquote> ## Type of change - [x] New feature (non-breaking change which adds functionality) ## How Has This Been Tested? ### Loom video https://www.loom.com/share/d325ab86ca514c6d8f90dfe72a8928dd ## 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: Muhsin Keloth <muhsinkeramam@gmail.com>
159 lines
4.5 KiB
Vue
159 lines
4.5 KiB
Vue
<script setup>
|
|
import { computed, ref, watch, useSlots } from 'vue';
|
|
|
|
import WootEditor from 'dashboard/components/widgets/WootWriter/Editor.vue';
|
|
|
|
const props = defineProps({
|
|
modelValue: { type: String, default: '' },
|
|
label: { type: String, default: '' },
|
|
placeholder: { type: String, default: '' },
|
|
focusOnMount: { type: Boolean, default: false },
|
|
maxLength: { type: Number, default: 200 },
|
|
showCharacterCount: { type: Boolean, default: true },
|
|
disabled: { type: Boolean, default: false },
|
|
message: { type: String, default: '' },
|
|
messageType: {
|
|
type: String,
|
|
default: 'info',
|
|
validator: value => ['info', 'error', 'success'].includes(value),
|
|
},
|
|
enableVariables: { type: Boolean, default: false },
|
|
enableCannedResponses: { type: Boolean, default: true },
|
|
enableCaptainTools: { type: Boolean, default: false },
|
|
signature: { type: String, default: '' },
|
|
allowSignature: { type: Boolean, default: false },
|
|
sendWithSignature: { type: Boolean, default: false },
|
|
channelType: { type: String, default: '' },
|
|
medium: { type: String, default: '' },
|
|
});
|
|
|
|
const emit = defineEmits(['update:modelValue']);
|
|
|
|
const slots = useSlots();
|
|
|
|
const isFocused = ref(false);
|
|
|
|
const characterCount = computed(() => props.modelValue.length);
|
|
|
|
const messageClass = computed(() => {
|
|
switch (props.messageType) {
|
|
case 'error':
|
|
return 'text-n-ruby-9 dark:text-n-ruby-9';
|
|
case 'success':
|
|
return 'text-n-teal-10 dark:text-n-teal-10';
|
|
default:
|
|
return 'text-n-slate-11 dark:text-n-slate-11';
|
|
}
|
|
});
|
|
|
|
const handleInput = value => {
|
|
if (!props.disabled) {
|
|
emit('update:modelValue', value);
|
|
}
|
|
};
|
|
|
|
const handleFocus = () => {
|
|
if (!props.disabled) {
|
|
isFocused.value = true;
|
|
}
|
|
};
|
|
|
|
const handleBlur = () => {
|
|
if (!props.disabled) {
|
|
isFocused.value = false;
|
|
}
|
|
};
|
|
|
|
watch(
|
|
() => props.modelValue,
|
|
newValue => {
|
|
if (props.maxLength && props.showCharacterCount && !slots.actions) {
|
|
if (characterCount.value >= props.maxLength) {
|
|
emit('update:modelValue', newValue.slice(0, props.maxLength));
|
|
}
|
|
}
|
|
}
|
|
);
|
|
</script>
|
|
|
|
<template>
|
|
<div class="flex flex-col min-w-0 gap-1">
|
|
<label v-if="label" class="mb-0.5 text-sm font-medium text-n-slate-12">
|
|
{{ label }}
|
|
</label>
|
|
<div
|
|
class="flex flex-col w-full gap-2 px-3 py-3 transition-all duration-500 ease-in-out border rounded-lg editor-wrapper bg-n-alpha-black2"
|
|
:class="[
|
|
{
|
|
'cursor-not-allowed opacity-50 pointer-events-none !bg-n-alpha-black2 disabled:border-n-weak dark:disabled:border-n-weak':
|
|
disabled,
|
|
'border-n-brand dark:border-n-brand': isFocused,
|
|
'hover:border-n-slate-6 dark:hover:border-n-slate-6 border-n-weak dark:border-n-weak':
|
|
!isFocused && messageType !== 'error',
|
|
'border-n-ruby-8 dark:border-n-ruby-8 hover:border-n-ruby-9 dark:hover:border-n-ruby-9':
|
|
messageType === 'error' && !isFocused,
|
|
},
|
|
]"
|
|
>
|
|
<WootEditor
|
|
:model-value="modelValue"
|
|
:placeholder="placeholder"
|
|
:focus-on-mount="focusOnMount"
|
|
:disabled="disabled"
|
|
:enable-variables="enableVariables"
|
|
:enable-canned-responses="enableCannedResponses"
|
|
:enable-captain-tools="enableCaptainTools"
|
|
:signature="signature"
|
|
:allow-signature="allowSignature"
|
|
:send-with-signature="sendWithSignature"
|
|
:channel-type="channelType"
|
|
:medium="medium"
|
|
@input="handleInput"
|
|
@focus="handleFocus"
|
|
@blur="handleBlur"
|
|
/>
|
|
<div
|
|
v-if="showCharacterCount || slots.actions"
|
|
class="flex items-center justify-end h-4 ltr:right-3 rtl:left-3"
|
|
>
|
|
<span
|
|
v-if="showCharacterCount && !slots.actions"
|
|
class="text-xs tabular-nums text-n-slate-10"
|
|
>
|
|
{{ characterCount }} / {{ maxLength }}
|
|
</span>
|
|
<slot v-else name="actions" />
|
|
</div>
|
|
</div>
|
|
<p
|
|
v-if="message"
|
|
class="min-w-0 mt-1 mb-0 text-xs truncate transition-all duration-500 ease-in-out"
|
|
:class="messageClass"
|
|
>
|
|
{{ message }}
|
|
</p>
|
|
</div>
|
|
</template>
|
|
|
|
<style lang="scss" scoped>
|
|
.editor-wrapper {
|
|
::v-deep {
|
|
.ProseMirror-menubar-wrapper {
|
|
.ProseMirror.ProseMirror-woot-style {
|
|
p {
|
|
@apply first:mt-0 !important;
|
|
}
|
|
|
|
.empty-node {
|
|
@apply m-0 !important;
|
|
|
|
&::before {
|
|
@apply text-n-slate-11 dark:text-n-slate-11;
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
</style>
|