mirror of
https://github.com/lingble/chatwoot.git
synced 2025-11-02 12:08:01 +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>
258 lines
6.0 KiB
Vue
258 lines
6.0 KiB
Vue
<script>
|
|
import {
|
|
fullSchema,
|
|
buildEditor,
|
|
EditorView,
|
|
ArticleMarkdownSerializer,
|
|
ArticleMarkdownTransformer,
|
|
EditorState,
|
|
Selection,
|
|
} from '@chatwoot/prosemirror-schema';
|
|
import { checkFileSizeLimit } from 'shared/helpers/FileHelper';
|
|
import { useAlert } from 'dashboard/composables';
|
|
import { useUISettings } from 'dashboard/composables/useUISettings';
|
|
import keyboardEventListenerMixins from 'shared/mixins/keyboardEventListenerMixins';
|
|
|
|
const MAXIMUM_FILE_UPLOAD_SIZE = 4; // in MB
|
|
const createState = (
|
|
content,
|
|
placeholder,
|
|
// eslint-disable-next-line default-param-last
|
|
plugins = [],
|
|
// eslint-disable-next-line default-param-last
|
|
methods = {},
|
|
enabledMenuOptions
|
|
) => {
|
|
return EditorState.create({
|
|
doc: new ArticleMarkdownTransformer(fullSchema).parse(content),
|
|
plugins: buildEditor({
|
|
schema: fullSchema,
|
|
placeholder,
|
|
methods,
|
|
plugins,
|
|
enabledMenuOptions,
|
|
}),
|
|
});
|
|
};
|
|
|
|
export default {
|
|
mixins: [keyboardEventListenerMixins],
|
|
props: {
|
|
value: { type: String, default: '' },
|
|
editorId: { type: String, default: '' },
|
|
placeholder: { type: String, default: '' },
|
|
enabledMenuOptions: { type: Array, default: () => [] },
|
|
},
|
|
setup() {
|
|
const { uiSettings, updateUISettings } = useUISettings();
|
|
|
|
return {
|
|
uiSettings,
|
|
updateUISettings,
|
|
};
|
|
},
|
|
data() {
|
|
return {
|
|
editorView: null,
|
|
state: undefined,
|
|
plugins: [],
|
|
};
|
|
},
|
|
computed: {
|
|
contentFromEditor() {
|
|
if (this.editorView) {
|
|
return ArticleMarkdownSerializer.serialize(this.editorView.state.doc);
|
|
}
|
|
return '';
|
|
},
|
|
},
|
|
watch: {
|
|
value(newValue = '') {
|
|
if (newValue !== this.contentFromEditor) {
|
|
this.reloadState();
|
|
}
|
|
},
|
|
editorId() {
|
|
this.reloadState();
|
|
},
|
|
},
|
|
created() {
|
|
this.state = createState(
|
|
this.value,
|
|
this.placeholder,
|
|
this.plugins,
|
|
{ onImageUpload: this.openFileBrowser },
|
|
this.enabledMenuOptions
|
|
);
|
|
},
|
|
mounted() {
|
|
this.createEditorView();
|
|
|
|
this.editorView.updateState(this.state);
|
|
this.focusEditorInputField();
|
|
},
|
|
methods: {
|
|
openFileBrowser() {
|
|
this.$refs.imageUploadInput.click();
|
|
},
|
|
onFileChange() {
|
|
const file = this.$refs.imageUploadInput.files[0];
|
|
|
|
if (checkFileSizeLimit(file, MAXIMUM_FILE_UPLOAD_SIZE)) {
|
|
this.uploadImageToStorage(file);
|
|
} else {
|
|
useAlert(
|
|
this.$t('HELP_CENTER.ARTICLE_EDITOR.IMAGE_UPLOAD.ERROR_FILE_SIZE', {
|
|
size: MAXIMUM_FILE_UPLOAD_SIZE,
|
|
})
|
|
);
|
|
}
|
|
|
|
this.$refs.imageUploadInput.value = '';
|
|
},
|
|
async uploadImageToStorage(file) {
|
|
try {
|
|
const fileUrl = await this.$store.dispatch('articles/attachImage', {
|
|
portalSlug: this.$route.params.portalSlug,
|
|
file,
|
|
});
|
|
|
|
if (fileUrl) {
|
|
this.onImageUploadStart(fileUrl);
|
|
}
|
|
useAlert(this.$t('HELP_CENTER.ARTICLE_EDITOR.IMAGE_UPLOAD.SUCCESS'));
|
|
} catch (error) {
|
|
useAlert(this.$t('HELP_CENTER.ARTICLE_EDITOR.IMAGE_UPLOAD.ERROR'));
|
|
}
|
|
},
|
|
onImageUploadStart(fileUrl) {
|
|
const { selection } = this.editorView.state;
|
|
const from = selection.from;
|
|
const node = this.editorView.state.schema.nodes.image.create({
|
|
src: fileUrl,
|
|
});
|
|
const paragraphNode = this.editorView.state.schema.node('paragraph');
|
|
if (node) {
|
|
// Insert the image and the caption wrapped inside a paragraph
|
|
const tr = this.editorView.state.tr
|
|
.replaceSelectionWith(paragraphNode)
|
|
.insert(from + 1, node);
|
|
|
|
this.editorView.dispatch(tr.scrollIntoView());
|
|
this.focusEditorInputField();
|
|
}
|
|
},
|
|
reloadState() {
|
|
this.state = createState(
|
|
this.value,
|
|
this.placeholder,
|
|
this.plugins,
|
|
{ onImageUpload: this.openFileBrowser },
|
|
this.enabledMenuOptions
|
|
);
|
|
this.editorView.updateState(this.state);
|
|
this.focusEditorInputField();
|
|
},
|
|
createEditorView() {
|
|
this.editorView = new EditorView(this.$refs.editor, {
|
|
state: this.state,
|
|
dispatchTransaction: tx => {
|
|
this.state = this.state.apply(tx);
|
|
this.emitOnChange();
|
|
},
|
|
handleDOMEvents: {
|
|
keyup: () => {
|
|
this.onKeyup();
|
|
},
|
|
keydown: (view, event) => {
|
|
this.onKeydown(event);
|
|
},
|
|
focus: () => {
|
|
this.onFocus();
|
|
},
|
|
blur: () => {
|
|
this.onBlur();
|
|
},
|
|
},
|
|
});
|
|
},
|
|
|
|
handleKeyEvents() {},
|
|
focusEditorInputField() {
|
|
const { tr } = this.editorView.state;
|
|
const selection = Selection.atEnd(tr.doc);
|
|
|
|
this.editorView.dispatch(tr.setSelection(selection));
|
|
this.editorView.focus();
|
|
},
|
|
|
|
emitOnChange() {
|
|
this.editorView.updateState(this.state);
|
|
|
|
this.$emit('input', this.contentFromEditor);
|
|
},
|
|
|
|
onKeyup() {
|
|
this.$emit('keyup');
|
|
},
|
|
onKeydown() {
|
|
this.$emit('keydown');
|
|
},
|
|
onBlur() {
|
|
this.$emit('blur');
|
|
},
|
|
onFocus() {
|
|
this.$emit('focus');
|
|
},
|
|
},
|
|
};
|
|
</script>
|
|
|
|
<template>
|
|
<div>
|
|
<div class="editor-root editor--article">
|
|
<input
|
|
ref="imageUploadInput"
|
|
type="file"
|
|
accept="image/png, image/jpeg, image/jpg, image/gif, image/webp"
|
|
hidden
|
|
@change="onFileChange"
|
|
/>
|
|
<div ref="editor" />
|
|
</div>
|
|
</div>
|
|
</template>
|
|
|
|
<style lang="scss">
|
|
@import '~@chatwoot/prosemirror-schema/src/styles/article.scss';
|
|
|
|
.ProseMirror-menubar-wrapper {
|
|
display: flex;
|
|
flex-direction: column;
|
|
|
|
> .ProseMirror {
|
|
padding: 0;
|
|
word-break: break-word;
|
|
}
|
|
}
|
|
|
|
.editor-root {
|
|
width: 100%;
|
|
}
|
|
|
|
.ProseMirror-woot-style {
|
|
min-height: 5rem;
|
|
max-height: 7.5rem;
|
|
overflow: auto;
|
|
}
|
|
|
|
.ProseMirror-prompt {
|
|
z-index: var(--z-index-highest);
|
|
background: var(--white);
|
|
box-shadow: var(--shadow-large);
|
|
border-radius: var(--border-radius-normal);
|
|
border: 1px solid var(--color-border);
|
|
min-width: 25rem;
|
|
}
|
|
</style>
|