From bd7a56061e8e2266471a6cf1b5cb0118f238a90e Mon Sep 17 00:00:00 2001
From: Muhsin Keloth <muhsinkeramam@gmail.com>
Date: Tue, 26 Jul 2022 12:15:01 +0530
Subject: [PATCH] feat: Create category component (#5103)

---
 .../helpCenter/AddCategory.stories.js         |  30 ++++
 .../components/helpCenter/AddCategory.vue     | 160 ++++++++++++++++++
 .../components/widgets/forms/Input.vue        |  24 ++-
 app/javascript/dashboard/helper/commons.js    |   9 +-
 .../dashboard/helper/specs/commons.spec.js    |  17 +-
 .../dashboard/i18n/locale/en/helpCenter.json  |  29 ++++
 .../settings/attributes/AddAttribute.vue      |   4 +-
 7 files changed, 264 insertions(+), 9 deletions(-)
 create mode 100644 app/javascript/dashboard/components/helpCenter/AddCategory.stories.js
 create mode 100644 app/javascript/dashboard/components/helpCenter/AddCategory.vue

diff --git a/app/javascript/dashboard/components/helpCenter/AddCategory.stories.js b/app/javascript/dashboard/components/helpCenter/AddCategory.stories.js
new file mode 100644
index 000000000..024d85fe7
--- /dev/null
+++ b/app/javascript/dashboard/components/helpCenter/AddCategory.stories.js
@@ -0,0 +1,30 @@
+import AddCategoryComponent from './AddCategory.vue';
+import { action } from '@storybook/addon-actions';
+
+export default {
+  title: 'Components/Help Center',
+  component: AddCategoryComponent,
+  argTypes: {
+    show: {
+      defaultValue: true,
+      control: {
+        type: 'boolean',
+      },
+    },
+  },
+};
+
+const Template = (args, { argTypes }) => ({
+  props: Object.keys(argTypes),
+  components: { AddCategoryComponent },
+  template:
+    '<add-category-component v-bind="$props" @create="onCreate" @cancel="onClose" />',
+});
+
+export const AddCategory = Template.bind({});
+AddCategory.args = {
+  portalName: 'Chatwoot help center',
+  locale: 'En-US',
+  onCreate: action('create'),
+  onClose: action('cancel'),
+};
diff --git a/app/javascript/dashboard/components/helpCenter/AddCategory.vue b/app/javascript/dashboard/components/helpCenter/AddCategory.vue
new file mode 100644
index 000000000..2a1b9854c
--- /dev/null
+++ b/app/javascript/dashboard/components/helpCenter/AddCategory.vue
@@ -0,0 +1,160 @@
+<template>
+  <modal :show.sync="show" :on-close="onClose">
+    <woot-modal-header
+      :header-title="$t('HELP_CENTER.CATEGORY.ADD.TITLE')"
+      :header-content="$t('HELP_CENTER.CATEGORY.ADD.SUB_TITLE')"
+    />
+    <form class="row" @submit.prevent="onCreate">
+      <div class="medium-12 columns">
+        <div class="row article-info">
+          <div class="columns medium-6">
+            <label>
+              <span>{{ $t('HELP_CENTER.CATEGORY.ADD.PORTAL') }}</span>
+              <p class="value">{{ portalName }}</p>
+            </label>
+          </div>
+          <div class="columns medium-6">
+            <label>
+              <span>{{ $t('HELP_CENTER.CATEGORY.ADD.LOCALE') }}</span>
+              <p class="value">{{ locale }}</p>
+            </label>
+          </div>
+        </div>
+        <woot-input
+          v-model.trim="name"
+          :class="{ error: $v.name.$error }"
+          class="medium-12 columns"
+          :error="nameError"
+          :label="$t('HELP_CENTER.CATEGORY.ADD.NAME.LABEL')"
+          :placeholder="$t('HELP_CENTER.CATEGORY.ADD.NAME.PLACEHOLDER')"
+          :help-text="$t('HELP_CENTER.CATEGORY.ADD.NAME.HELP_TEXT')"
+          @input="onNameChange"
+        />
+        <woot-input
+          v-model.trim="slug"
+          :class="{ error: $v.slug.$error }"
+          class="medium-12 columns"
+          :error="slugError"
+          :label="$t('HELP_CENTER.CATEGORY.ADD.SLUG.LABEL')"
+          :placeholder="$t('HELP_CENTER.CATEGORY.ADD.SLUG.PLACEHOLDER')"
+          :help-text="$t('HELP_CENTER.CATEGORY.ADD.SLUG.HELP_TEXT')"
+          @input="$v.slug.$touch"
+        />
+        <label :class="{ error: $v.description.$error }">
+          {{ $t('HELP_CENTER.CATEGORY.ADD.DESCRIPTION.LABEL') }}
+          <textarea
+            v-model="description"
+            rows="3"
+            type="text"
+            :placeholder="
+              $t('HELP_CENTER.CATEGORY.ADD.DESCRIPTION.PLACEHOLDER')
+            "
+            @blur="$v.description.$touch"
+          />
+          <span v-if="$v.description.$error" class="message">
+            {{ $t('HELP_CENTER.CATEGORY.ADD.DESCRIPTION.ERROR') }}
+          </span>
+        </label>
+        <div class="medium-12 columns">
+          <div class="modal-footer justify-content-end w-full">
+            <woot-button class="button clear" @click.prevent="onClose">
+              {{ $t('HELP_CENTER.CATEGORY.ADD.BUTTONS.CANCEL') }}
+            </woot-button>
+            <woot-button>
+              {{ $t('HELP_CENTER.CATEGORY.ADD.BUTTONS.CREATE') }}
+            </woot-button>
+          </div>
+        </div>
+      </div>
+    </form>
+  </modal>
+</template>
+
+<script>
+import Modal from 'dashboard/components/Modal';
+import alertMixin from 'shared/mixins/alertMixin';
+import { required, minLength } from 'vuelidate/lib/validators';
+import { convertToCategorySlug } from 'dashboard/helper/commons.js';
+
+export default {
+  components: {
+    Modal,
+  },
+  mixins: [alertMixin],
+  props: {
+    show: {
+      type: Boolean,
+      default: true,
+    },
+    portalName: {
+      type: String,
+      default: '',
+    },
+    locale: {
+      type: String,
+      default: '',
+    },
+  },
+  data() {
+    return {
+      name: '',
+      slug: '',
+      description: '',
+    };
+  },
+  validations: {
+    name: {
+      required,
+      minLength: minLength(2),
+    },
+    slug: {
+      required,
+    },
+    description: {
+      required,
+    },
+  },
+  computed: {
+    nameError() {
+      if (this.$v.name.$error) {
+        return this.$t('HELP_CENTER.CATEGORY.ADD.NAME.ERROR');
+      }
+      return '';
+    },
+    slugError() {
+      if (this.$v.slug.$error) {
+        return this.$t('HELP_CENTER.CATEGORY.ADD.SLUG.ERROR');
+      }
+      return '';
+    },
+  },
+  methods: {
+    onNameChange() {
+      this.slug = convertToCategorySlug(this.name);
+    },
+    onCreate() {
+      this.$emit('create');
+      this.reset();
+      this.$emit('cancel');
+    },
+    onClose() {
+      this.reset();
+      this.$emit('cancel');
+    },
+    reset() {
+      this.name = '';
+      this.slug = '';
+      this.description = '';
+    },
+  },
+};
+</script>
+<style scoped lang="scss">
+.article-info {
+  width: 100%;
+  margin: 0 0 var(--space-normal);
+  .value {
+    color: var(--s-600);
+  }
+}
+</style>
diff --git a/app/javascript/dashboard/components/widgets/forms/Input.vue b/app/javascript/dashboard/components/widgets/forms/Input.vue
index 0161240b8..045b67c7a 100644
--- a/app/javascript/dashboard/components/widgets/forms/Input.vue
+++ b/app/javascript/dashboard/components/widgets/forms/Input.vue
@@ -1,5 +1,5 @@
 <template>
-  <label>
+  <label class="container">
     <span v-if="label">{{ label }}</span>
     <input
       :value="value"
@@ -10,7 +10,7 @@
       @input="onChange"
       @blur="onBlur"
     />
-    <p v-if="helpText" class="help-text" />
+    <p v-if="helpText" class="help-text">{{ helpText }}</p>
     <span v-if="error" class="message">
       {{ error }}
     </span>
@@ -46,7 +46,7 @@ export default {
     },
     readonly: {
       type: Boolean,
-      deafaut: false,
+      default: false,
     },
     styles: {
       type: Object,
@@ -63,3 +63,21 @@ export default {
   },
 };
 </script>
+<style scoped lang="scss">
+.container {
+  margin: 0 0 var(--space-normal);
+  input {
+    margin: 0;
+  }
+  .page-sub-title {
+    color: var(--s-600);
+  }
+
+  .help-text {
+    margin-top: var(--space-micro);
+    font-size: var(--font-size-mini);
+    color: var(--s-600);
+    font-style: normal;
+  }
+}
+</style>
diff --git a/app/javascript/dashboard/helper/commons.js b/app/javascript/dashboard/helper/commons.js
index 85e997802..346628985 100644
--- a/app/javascript/dashboard/helper/commons.js
+++ b/app/javascript/dashboard/helper/commons.js
@@ -62,9 +62,16 @@ export const createPendingMessage = data => {
   return pendingMessage;
 };
 
-export const convertToSlug = text => {
+export const convertToAttributeSlug = text => {
   return text
     .toLowerCase()
     .replace(/[^\w ]+/g, '')
     .replace(/ +/g, '_');
 };
+
+export const convertToCategorySlug = text => {
+  return text
+    .toLowerCase()
+    .replace(/[^\w ]+/g, '')
+    .replace(/ +/g, '-');
+};
diff --git a/app/javascript/dashboard/helper/specs/commons.spec.js b/app/javascript/dashboard/helper/specs/commons.spec.js
index 379e97e86..3ab06c02a 100644
--- a/app/javascript/dashboard/helper/specs/commons.spec.js
+++ b/app/javascript/dashboard/helper/specs/commons.spec.js
@@ -1,7 +1,8 @@
 import {
   getTypingUsersText,
   createPendingMessage,
-  convertToSlug,
+  convertToAttributeSlug,
+  convertToCategorySlug,
 } from '../commons';
 
 describe('#getTypingUsersText', () => {
@@ -88,8 +89,18 @@ describe('#createPendingMessage', () => {
   });
 });
 
-describe('convertToSlug', () => {
+describe('convertToAttributeSlug', () => {
   it('should convert to slug', () => {
-    expect(convertToSlug('Test@%^&*(){}>.!@`~_ ing')).toBe('test__ing');
+    expect(convertToAttributeSlug('Test@%^&*(){}>.!@`~_ ing')).toBe(
+      'test__ing'
+    );
+  });
+});
+
+describe('convertToCategorySlug', () => {
+  it('should convert to slug', () => {
+    expect(convertToCategorySlug('User profile guide')).toBe(
+      'user-profile-guide'
+    );
   });
 });
diff --git a/app/javascript/dashboard/i18n/locale/en/helpCenter.json b/app/javascript/dashboard/i18n/locale/en/helpCenter.json
index e3a5a4715..278558db0 100644
--- a/app/javascript/dashboard/i18n/locale/en/helpCenter.json
+++ b/app/javascript/dashboard/i18n/locale/en/helpCenter.json
@@ -40,6 +40,35 @@
       "SEARCH": {
         "PLACEHOLDER": "Search for articles"
       }
+    },
+    "CATEGORY": {
+      "ADD": {
+        "TITLE": "Create a category",
+        "SUB_TITLE": "The category will be used in the public facing portal to categorize articles.",
+        "PORTAL": "Portal",
+        "LOCALE": "Locale",
+        "NAME": {
+          "LABEL": "Name",
+          "PLACEHOLDER": "Category name",
+          "HELP_TEXT": "The category name will be used in the public facing portal to categorize articles.",
+          "ERROR": "Name is required"
+        },
+        "SLUG": {
+          "LABEL": "Slug",
+          "PLACEHOLDER": "Category slug for urls",
+          "HELP_TEXT": "app.chatwoot.com/portal/my-portal/en-US/categories/my-slug",
+          "ERROR": "Slug is required"
+        },
+        "DESCRIPTION": {
+          "LABEL": "Description",
+          "PLACEHOLDER": "Give a short description about the category.",
+          "ERROR": "Description is required"
+        },
+        "BUTTONS": {
+          "CREATE": "Create category",
+          "CANCEL": "Cancel"
+        }
+      }
     }
   }
 }
diff --git a/app/javascript/dashboard/routes/dashboard/settings/attributes/AddAttribute.vue b/app/javascript/dashboard/routes/dashboard/settings/attributes/AddAttribute.vue
index 75d0e0f72..38750eb5f 100644
--- a/app/javascript/dashboard/routes/dashboard/settings/attributes/AddAttribute.vue
+++ b/app/javascript/dashboard/routes/dashboard/settings/attributes/AddAttribute.vue
@@ -104,7 +104,7 @@
 <script>
 import { required, minLength } from 'vuelidate/lib/validators';
 import { mapGetters } from 'vuex';
-import { convertToSlug } from 'dashboard/helper/commons.js';
+import { convertToAttributeSlug } from 'dashboard/helper/commons.js';
 import { ATTRIBUTE_MODELS, ATTRIBUTE_TYPES } from './constants';
 import alertMixin from 'shared/mixins/alertMixin';
 
@@ -199,7 +199,7 @@ export default {
       this.isTouched = true;
     },
     onDisplayNameChange() {
-      this.attributeKey = convertToSlug(this.displayName);
+      this.attributeKey = convertToAttributeSlug(this.displayName);
     },
     async addAttributes() {
       this.$v.$touch();