mirror of
https://github.com/lingble/chatwoot.git
synced 2025-11-02 20:18:08 +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>
126 lines
3.3 KiB
Vue
126 lines
3.3 KiB
Vue
<script>
|
|
export default {
|
|
props: {
|
|
rows: {
|
|
type: Array,
|
|
default: () => [],
|
|
},
|
|
},
|
|
data() {
|
|
return {
|
|
currentSlug: window.location?.hash?.substring(1) || '',
|
|
intersectionObserver: null,
|
|
};
|
|
},
|
|
computed: {
|
|
h1Count() {
|
|
return this.rows.filter(el => el.tag === 'h1').length;
|
|
},
|
|
h2Count() {
|
|
return this.rows.filter(el => el.tag === 'h2').length;
|
|
},
|
|
},
|
|
mounted() {
|
|
this.initializeIntersectionObserver();
|
|
window.addEventListener('hashchange', this.onURLHashChange);
|
|
},
|
|
beforeDestroy() {
|
|
window.removeEventListener('hashchange', this.onURLHashChange);
|
|
if (this.intersectionObserver) {
|
|
this.intersectionObserver.disconnect();
|
|
}
|
|
},
|
|
methods: {
|
|
getClassName(el) {
|
|
if (el.tag === 'h1') {
|
|
return '';
|
|
}
|
|
if (el.tag === 'h2') {
|
|
if (this.h1Count > 0) {
|
|
return 'ml-2';
|
|
}
|
|
return '';
|
|
}
|
|
|
|
if (el.tag === 'h3') {
|
|
if (!this.h1Count && !this.h2Count) {
|
|
return '';
|
|
}
|
|
return 'ml-5';
|
|
}
|
|
|
|
return '';
|
|
},
|
|
initializeIntersectionObserver() {
|
|
this.intersectionObserver = new IntersectionObserver(
|
|
entries => {
|
|
const currentSection = entries.find(entry => entry.isIntersecting);
|
|
if (currentSection) {
|
|
this.currentSlug = currentSection.target.id;
|
|
}
|
|
},
|
|
{
|
|
threshold: 0.25,
|
|
rootMargin: '0px 0px -20% 0px',
|
|
}
|
|
);
|
|
|
|
this.rows.forEach(el => {
|
|
const sectionElement = document.getElementById(el.slug);
|
|
if (!sectionElement) return;
|
|
this.intersectionObserver.observe(sectionElement);
|
|
});
|
|
},
|
|
onURLHashChange() {
|
|
this.currentSlug = window.location?.hash?.substring(1) || '';
|
|
},
|
|
isElementActive(el) {
|
|
return this.currentSlug === el.slug;
|
|
},
|
|
elementBorderStyles(el) {
|
|
if (this.isElementActive(el)) {
|
|
return 'border-slate-400 dark:border-slate-50 transition-colors duration-200';
|
|
}
|
|
return 'border-slate-100 dark:border-slate-800';
|
|
},
|
|
elementTextStyles(el) {
|
|
if (this.isElementActive(el)) {
|
|
return 'text-slate-900 dark:text-slate-25 transition-colors duration-200';
|
|
}
|
|
return 'text-slate-700 dark:text-slate-100';
|
|
},
|
|
},
|
|
};
|
|
</script>
|
|
|
|
<template>
|
|
<div class="hidden lg:block flex-1 py-6 scroll-mt-24 pl-4">
|
|
<div v-if="rows.length > 0" class="sticky top-24 py-2 overflow-auto">
|
|
<nav class="max-w-2xl">
|
|
<ol
|
|
role="list"
|
|
class="flex flex-col gap-2 text-base border-l-2 border-solid border-slate-100 dark:border-slate-800"
|
|
>
|
|
<li
|
|
v-for="element in rows"
|
|
:key="element.slug"
|
|
class="leading-6 border-l-2 relative -left-0.5 border-solid"
|
|
:class="elementBorderStyles(element)"
|
|
>
|
|
<p class="py-1 px-3" :class="getClassName(element)">
|
|
<a
|
|
:href="`#${element.slug}`"
|
|
data-turbolinks="false"
|
|
class="font-medium text-sm tracking-[0.28px] cursor-pointer"
|
|
:class="elementTextStyles(element)"
|
|
>
|
|
{{ element.title }}
|
|
</a>
|
|
</p>
|
|
</li>
|
|
</ol>
|
|
</nav>
|
|
</div>
|
|
</div>
|
|
</template>
|