@mythpe/quasar-ui-qui 0.0.27-dev → 0.0.28-dev

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mythpe/quasar-ui-qui",
-  "version": "0.0.27-dev",
+  "version": "0.0.28-dev",
   "description": "MyTh Quasar UI Kit App Extension",
   "author": {
     "name": "MyTh Ahmed Faiz",
@@ -24,9 +24,11 @@
     "build:css": "node build/script.css.js"
   },
   "dependencies": {
+    "@ckeditor/ckeditor5-vue": "^7.3.0",
     "@vee-validate/i18n": "^4.14.0",
     "@vee-validate/rules": "^4.14.0",
     "axios": "^1.7.8",
+    "ckeditor5": "^43.3.1",
     "lodash": "^4.17.0",
     "lodash-inflection": "^1.5.0",
     "typed.js": "^2.1.0",

package/src/components/form/MCkeditor.vue

@@ -0,0 +1,403 @@
+<!--
+  - MyTh Ahmed Faiz Copyright © 2016-2024 All rights reserved.
+  - Email: mythpe@gmail.com
+  - Mobile: +966590470092
+  - Website: https://www.4myth.com
+  - Github: https://github.com/mythpe
+  -->
+
+<script
+  lang="ts"
+  setup
+>
+
+import { useField } from 'vee-validate'
+import type { MCkeditorProps as Props } from '../../types'
+import { computed, reactive, toValue, useTemplateRef } from 'vue'
+import { useBindInput, useMyth } from '../../composable'
+
+import type {
+  Alignment,
+  Autoformat,
+  Base64UploadAdapter,
+  BlockQuote,
+  Bold,
+  CKFinder,
+  CKFinderUploadAdapter,
+  ClassicEditor,
+  CloudServices,
+  Code,
+  CodeBlock,
+  EditorConfig,
+  Essentials,
+  FontBackgroundColor,
+  FontColor,
+  FontFamily,
+  FontSize,
+  Heading,
+  Image,
+  ImageCaption,
+  ImageResize,
+  ImageStyle,
+  ImageToolbar,
+  ImageUpload,
+  Indent,
+  IndentBlock,
+  Italic,
+  Link,
+  List,
+  MediaEmbed,
+  Mention,
+  Paragraph,
+  PasteFromOffice,
+  PictureEditing,
+  RemoveFormat,
+  SourceEditing,
+  Strikethrough,
+  Subscript,
+  Superscript,
+  Table,
+  TableColumnResize,
+  TableToolbar,
+  TextTransformation,
+  TodoList,
+  Underline
+} from 'ckeditor5'
+import { Ckeditor } from '@ckeditor/ckeditor5-vue'
+// eslint-disable-next-line @typescript-eslint/ban-ts-comment
+// @ts-ignore
+import arTranslations from 'ckeditor5/translations/ar.js'
+// eslint-disable-next-line @typescript-eslint/ban-ts-comment
+// @ts-ignore
+import enTranslations from 'ckeditor5/translations/en.js'
+
+type P = {
+  name: Props['name'];
+  lang: Props['lang'];
+  config?: Props['config'];
+  tagName?: Props['tagName'];
+  disabled?: Props['disabled'];
+  disableTwoWayDataBinding?: Props['disableTwoWayDataBinding'];
+
+  auto?: Props['auto'];
+  col?: Props['col'];
+  xs?: Props['xs'];
+  sm?: Props['sm'];
+  md?: Props['md'];
+  lg?: Props['lg'];
+  xl?: Props['xl'];
+  label?: Props['label'];
+  caption?: Props['caption'];
+  help?: Props['help'];
+  required?: Props['required'];
+  rules?: Props['rules'];
+  viewMode?: Props['viewMode'];
+  viewModeValue?: Props['viewModeValue'];
+  fieldOptions?: Props['fieldOptions'];
+}
+const props = withDefaults(defineProps<P>(), {
+  name: () => '',
+  lang: () => 'ar',
+  config: undefined,
+  tagName: () => 'div',
+  disabled: () => !1,
+  disableTwoWayDataBinding: () => !1,
+
+  auto: undefined,
+  col: undefined,
+  xs: undefined,
+  sm: undefined,
+  md: undefined,
+  lg: undefined,
+  xl: undefined,
+  label: undefined,
+  caption: undefined,
+  help: undefined,
+  required: undefined,
+  rules: undefined,
+  viewMode: () => !1,
+  viewModeValue: undefined,
+  fieldOptions: undefined
+})
+defineModel<Props['modelValue']>({ required: !1, default: undefined })
+const { __, mOptions } = useMyth()
+const helper = useBindInput<any>(() => props, 'ckeditor')
+const { getLabel, inputRules } = helper
+const inputScope = useField<Props['modelValue']>(() => props.name, inputRules, {
+  validateOnMount: !1,
+  validateOnValueUpdate: !1,
+  syncVModel: !0,
+  label: getLabel,
+  ...toValue<any>(props.fieldOptions)
+})
+const { value, errorMessage, handleChange } = inputScope
+
+const isRtl = computed(() => props.lang === 'ar')
+const getConfig = computed<EditorConfig>(() => {
+  const inpConfig = {
+    language: {
+      ui: props.lang as string,
+      content: props.lang as string,
+      textPartLanguage: [
+        {
+          title: __('ar'),
+          languageCode: 'ar',
+          textDirection: 'rtl'
+        },
+        {
+          title: __('en'),
+          languageCode: 'en',
+          textDirection: 'ltr'
+        }
+      ]
+    },
+    translations: [
+      arTranslations,
+      enTranslations
+    ],
+    plugins: [
+      Autoformat,
+      BlockQuote,
+      Bold,
+      CKFinder,
+      CKFinderUploadAdapter,
+      CloudServices,
+      Essentials,
+      Heading,
+      Image,
+      ImageCaption,
+      ImageResize,
+      ImageStyle,
+      ImageToolbar,
+      ImageUpload,
+      Base64UploadAdapter,
+      Indent,
+      IndentBlock,
+      Italic,
+      Link,
+      List,
+      MediaEmbed,
+      Mention,
+      Paragraph,
+      PasteFromOffice,
+      PictureEditing,
+      Table,
+      TableColumnResize,
+      TableToolbar,
+      TextTransformation,
+      Underline,
+      FontSize,
+      FontFamily,
+      FontColor,
+      FontBackgroundColor,
+      RemoveFormat,
+      Strikethrough,
+      Subscript,
+      Code,
+      CodeBlock,
+      Alignment,
+      Superscript,
+      TodoList,
+      SourceEditing
+    ],
+    toolbar: {
+      items: [
+        'undo',
+        'redo',
+        '|',
+        'bold', 'italic', 'underline', 'strikethrough', 'subscript', 'superscript', 'code',
+        '|',
+        'fontfamily', 'fontsize', 'fontColor', 'fontBackgroundColor',
+        '|',
+        'alignment',
+        'insertTable',
+        'heading',
+        '|',
+        'link', 'uploadImage', 'blockQuote', 'codeBlock',
+        '|',
+        'bulletedList', 'numberedList', 'todoList', 'outdent', 'indent',
+        '|',
+        // 'ckbox',
+        'removeFormat',
+        'mediaEmbed',
+        '|',
+        'sourceEditing'
+      ],
+      shouldNotGroupWhenFull: true
+    },
+    heading: {
+      options: [
+        {
+          model: 'paragraph',
+          title: 'Paragraph',
+          class: 'ck-heading_paragraph'
+        },
+        {
+          model: 'heading1',
+          view: 'h1',
+          title: 'Heading 1',
+          class: 'ck-heading_heading1'
+        },
+        {
+          model: 'heading2',
+          view: 'h2',
+          title: 'Heading 2',
+          class: 'ck-heading_heading2'
+        },
+        {
+          model: 'heading3',
+          view: 'h3',
+          title: 'Heading 3',
+          class: 'ck-heading_heading3'
+        },
+        {
+          model: 'heading4',
+          view: 'h4',
+          title: 'Heading 4',
+          class: 'ck-heading_heading4'
+        }
+      ]
+    },
+    image: {
+      resizeOptions: [
+        {
+          name: 'resizeImage:original',
+          label: 'Default image width',
+          value: null
+        },
+        {
+          name: 'resizeImage:50',
+          label: '50% page width',
+          value: '50'
+        },
+        {
+          name: 'resizeImage:75',
+          label: '75% page width',
+          value: '75'
+        }
+      ],
+      toolbar: [
+        'imageTextAlternative',
+        'toggleImageCaption',
+        '|',
+        'imageStyle:inline',
+        'imageStyle:wrapText',
+        'imageStyle:breakText',
+        '|',
+        'resizeImage'
+      ]
+    },
+    menuBar: {
+      isVisible: !1
+    },
+    link: {
+      addTargetToExternalLinks: true,
+      defaultProtocol: 'https://'
+    },
+    table: {
+      contentToolbar: ['tableColumn', 'tableRow', 'mergeTableCells']
+    }
+  }
+  if (props.config) {
+    return props.config(inpConfig as EditorConfig)
+  }
+  return inpConfig as EditorConfig
+})
+const listeners = {
+  'update:modelValue': (v: Props['modelValue']) => handleChange(v, !!errorMessage.value)
+}
+const input = useTemplateRef<any>('input')
+const scopes = reactive(inputScope)
+defineExpose<typeof scopes & { input: typeof input }>({ input, ...scopes })
+defineOptions({
+  name: 'MCkeditor',
+  inheritAttrs: !1
+})
+</script>
+
+<template>
+  <MCol
+    :auto="auto"
+    :class="[$attrs.class,{'m--input__required':inputRules?.required!==undefined,'m--input__error':!!errorMessage,'m--input__view':viewMode}]"
+    :col="col"
+    :lg="lg"
+    :md="md"
+    :name="name"
+    :sm="sm"
+    :xs="xs"
+  >
+    <slot
+      name="top-input"
+      v-bind="scopes"
+    />
+    <slot name="top-label">
+      <MInputLabel
+        v-if="!!getLabel"
+        :field="scopes"
+      >
+        <MHelpRow
+          :text="help"
+          tooltip
+        />
+      </MInputLabel>
+    </slot>
+    <slot name="caption">
+      <div
+        v-if="!!caption"
+        class="m--input__caption"
+      >
+        {{ __(caption) }}
+      </div>
+    </slot>
+    <slot
+      name="help"
+      v-bind="scopes"
+    >
+      <MHelpRow
+        v-if="!getLabel"
+        :text="help"
+      />
+    </slot>
+    <MTransition>
+      <div
+        v-if="!!errorMessage"
+        class="text-negative text-caption"
+      >
+        <q-icon
+          v-if="!!errorMessage"
+          color="negative"
+          name="ion-ios-information-circle-outline"
+          size="20px"
+        />
+        {{ errorMessage }}
+      </div>
+    </MTransition>
+    <div
+      v-if="viewMode"
+      v-html="value"
+    />
+    <div
+      v-else
+      :dir="isRtl ? 'rtl' : 'ltr'"
+      :style="`direction: ${isRtl ? 'rtl' : 'ltr'}`"
+      v-bind="$attrs"
+    >
+      <ckeditor
+        ref="input"
+        :config="getConfig"
+        :disable-two-way-data-binding="disableTwoWayDataBinding"
+        :disabled="disabled"
+        :editor="ClassicEditor"
+        :model-value="value || ''"
+        :tag-name="tagName"
+        v-bind="{...$attrs,...mOptions.ckeditor}"
+        v-on="listeners"
+      />
+      <slot v-bind="scopes" />
+    </div>
+    <slot
+      name="bottom-input"
+      v-bind="scopes"
+    />
+  </MCol>
+</template>

package/src/components/form/index.ts

@@ -10,6 +10,7 @@ import MAxios from './MAxios.vue'
 import MAvatarViewer from './MAvatarViewer.vue'
 import MBtn from './MBtn.vue'
 import MCheckbox from './MCheckbox.vue'
+import MCkeditor from './MCkeditor.vue'
 import MColor from './MColor.vue'
 import MDate from './MDate.vue'
 import MEditor from './MEditor.vue'
@@ -38,6 +39,7 @@ export {
   MAvatarViewer,
   MBtn,
   MCheckbox,
+  MCkeditor,
   MColor,
   MDate,
   MEditor,

package/src/types/components.d.ts

@@ -59,6 +59,7 @@ import {
   MDtContextmenuItemsProps,
   MDtContextmenuItemsSlots
 } from './m-datatable'
+import type { EditorConfig } from 'ckeditor5'
 
 export interface MTransitionProps extends TransitionGroupProps {
   enterIn?: string;
@@ -1154,6 +1155,37 @@ export type MDialogSlots = {
   default: () => VNode[];
 }
 
+export type MCkeditorProps = Omit<BaseInputsProps, 'hint' | 'topLabel' | 'placeholder' | 'autocomplete'> & {
+  /**
+   * Editor language.
+   * Default value: ar.
+   */
+  lang: 'ar' | 'en';
+  /**
+   * Specifies the configuration of the editor.
+   * https://ckeditor.com/docs/ckeditor5/latest/api/module_core_editor_editorconfig-EditorConfig.html
+   */
+  config?: ((config: EditorConfig) => EditorConfig) | undefined;
+  /**
+   * By default, the editor component creates a <div> container which is used as an element passed to the editor (for example, ClassicEditor#element).
+   * The element can be configured, so for example to create a <textarea>, use the following directive:
+   * tag-name="textarea"
+   * Default value: div.
+   */
+  tagName?: string;
+  /**
+   * This directive controls the isReadOnly property of the editor.
+   * Default value: false.
+   */
+  disabled?: boolean;
+  /**
+   * Allows disabling the two-way data binding mechanism.
+   * Default value: false.
+   */
+  disableTwoWayDataBinding?: boolean;
+}
+export type MCkeditorSlots = BaseInputsSlots
+
 declare module '@vue/runtime-core' {
   interface GlobalComponents {
     // Form.
@@ -1161,6 +1193,7 @@ declare module '@vue/runtime-core' {
     MAxios: GlobalComponentConstructor<MAxiosProps, MAxiosSlots>;
     MBtn: GlobalComponentConstructor<MBtnProps, MBtnSlots>;
     MCheckbox: GlobalComponentConstructor<MCheckboxProps, MCheckboxSlots>;
+    MCkeditor: GlobalComponentConstructor<MCkeditorProps, MCkeditorSlots>;
     MColor: GlobalComponentConstructor<MInputProps, MInputSlots>;
     MDate: GlobalComponentConstructor<MDateProps, MDateSlots>;
     MEditor: GlobalComponentConstructor<MEditorProps, MEditorSlots>;

package/src/types/plugin-props-option.d.ts

@@ -2,7 +2,7 @@ import type {
   MAvatarViewerProps,
   MBlockProps,
   MBtnProps,
-  MCheckboxProps,
+  MCheckboxProps, MCkeditorProps,
   MColProps,
   MColumnProps,
   MContainerProps,
@@ -105,6 +105,10 @@ export interface PropsContext {
    * MCheckbox component.
    */
   checkbox?: Partial<MCheckboxProps>;
+  /**
+   * MCkeditor component.
+   */
+  ckeditor?: Partial<MCkeditorProps>;
   /**
    * MRadio component.
    */
@@ -286,7 +290,7 @@ export interface PropsContext {
       btn?: {
         props?: Partial<QBtnProps>;
       };
-    }
+    };
   };
 }
 

package/src/utils/vue-plugin.ts

@@ -15,6 +15,7 @@ import {
   MBlock,
   MBtn,
   MCheckbox,
+  MCkeditor,
   MCol,
   MColor,
   MColumn,
@@ -97,6 +98,7 @@ function install (app: App, options: InstallOptions = {}) {
   app.component('MAxios', MAxios)
   app.component('MBtn', MBtn)
   app.component('MCheckbox', MCheckbox)
+  app.component('MCkeditor', MCkeditor)
   app.component('MColor', MColor)
   app.component('MDate', MDate)
   app.component('MEditor', MEditor)