@mythpe/quasar-ui-qui 0.0.9 → 0.0.10

package/.eslintrc.cjs

@@ -30,8 +30,8 @@ module.exports = {
     // Uncomment any of the lines below to choose desired strictness,
     // but leave only one uncommented!
     // See https://eslint.vuejs.org/rules/#available-rules
-    //'plugin:vue/vue3-essential', // Priority A: Essential (Error Prevention)
-     'plugin:vue/vue3-strongly-recommended', // Priority B: Strongly Recommended (Improving Readability)
+    // 'plugin:vue/vue3-essential', // Priority A: Essential (Error Prevention)
+    'plugin:vue/vue3-strongly-recommended', // Priority B: Strongly Recommended (Improving Readability)
     // 'plugin:vue/vue3-recommended', // Priority C: Recommended (Minimizing Arbitrary Choices and Cognitive Overhead)
     'standard'
   ],

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mythpe/quasar-ui-qui",
-  "version": "0.0.9",
+  "version": "0.0.10",
   "description": "MyTh Quasar UI Kit App Extension",
   "author": "MyTh Ahmed Faiz <mythpe@gmail.com>",
   "email": "mythpe@gmail.com",
@@ -21,6 +21,8 @@
     "build:css": "node build/script.css.js"
   },
   "dependencies": {
+    "lodash": "^4.17.21",
+    "typed.js": "^2.1.0",
     "vee-validate": "^4.14.7",
     "vue-i18n": "^10.0.4"
   },
@@ -31,6 +33,7 @@
     "@rollup/plugin-json": "^4.0.0",
     "@rollup/plugin-node-resolve": "^11.2.1",
     "@rollup/plugin-replace": "^2.4.2",
+    "@types/lodash": "^4.17.13",
     "@types/node": "^20.5.9",
     "@typescript-eslint/eslint-plugin": "^7.16.0",
     "@typescript-eslint/parser": "^7.16.0",

package/src/components/grid/MBlock.vue

@@ -17,7 +17,10 @@ const props = withDefaults(defineProps<Props>(), {
 })
 const block = computed(() => MythOptions.defaults.value.block ?? {})
 const options = computed<Props>(() => extend(!0, { ...props }, block.value))
-defineOptions({ name: 'MBlock', inheritAttrs: !1 })
+defineOptions({
+  name: 'MBlock',
+  inheritAttrs: !1
+})
 </script>
 
 <template>

package/src/components/grid/MCol.vue

@@ -0,0 +1,73 @@
+<script
+  lang="ts"
+  setup
+>
+import { computed } from 'vue'
+import type { MColProps } from '../../types'
+import lodash from 'lodash'
+
+interface Props {
+  name?: MColProps['name']
+  auto?: MColProps['auto']
+  col?: MColProps['col']
+  xs?: MColProps['xs']
+  sm?: MColProps['sm']
+  md?: MColProps['md']
+  lg?: MColProps['lg']
+  xl?: MColProps['xl']
+}
+
+const props = withDefaults(defineProps<Props>(), {
+  name: undefined,
+  auto: undefined,
+  col: undefined,
+  xs: undefined,
+  sm: undefined,
+  md: undefined,
+  lg: undefined,
+  xl: undefined
+})
+const classes = computed(() => {
+  const list: string[] = ['m--col']
+  if (props.auto === !0) {
+    list.push('col-auto')
+  }
+  if (props.col === 'grow') {
+    list.push('col-grow')
+  } else if (props.col === 'shrink') {
+    list.push('col-shrink')
+  } else if (typeof props.col === 'string') {
+    if (props.col?.toString()?.trim()?.length > 0 && !list.includes(`col-${props.col}`)) {
+      list.push(`col-${props.col}`)
+    }
+  }
+
+  for (const k of (['xs', 'sm', 'md', 'lg', 'xl'] as (keyof Props)[])) {
+    if (props[k] && typeof props[k] !== 'boolean') {
+      if (!list.includes(`col-${k}-${props[k]}`)) {
+        list.push(`col-${k}-${props[k]}`)
+      }
+    }
+  }
+
+  if (list.length === 1 && props.col !== !1) {
+    list.push('col')
+  }
+
+  return lodash.uniq(list)
+})
+defineOptions({
+  name: 'MCol',
+  inheritAttrs: !1
+})
+</script>
+
+<template>
+  <div
+    :class="classes"
+    :data-input-name="name??undefined"
+    v-bind="$attrs"
+  >
+    <slot />
+  </div>
+</template>

package/src/components/grid/MColumn.vue

@@ -0,0 +1,15 @@
+<script lang="ts" setup>
+defineOptions({
+  name: 'MColumn',
+  inheritAttrs: !1
+})
+</script>
+
+<template>
+  <div
+    class="m--column column"
+    v-bind="$attrs"
+  >
+    <slot />
+  </div>
+</template>

package/src/components/grid/MContainer.vue

@@ -0,0 +1,46 @@
+<!--
+  - 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 type { MContainerProps } from '../../types'
+import MythOptions from '../../utils'
+import { computed } from 'vue'
+
+interface Props {
+  size?: MContainerProps['size'];
+  fluid?: MContainerProps['fluid'];
+  dense?: MContainerProps['dense'];
+}
+
+const props = defineProps<Props>()
+const styles = computed(() => MythOptions.defaults.value?.style ?? {})
+const sizeProp = computed(() => {
+  if (props.size !== undefined) {
+    return props.size
+  }
+  return styles.value.gutters
+})
+defineOptions({
+  name: 'MContainer',
+  inheritAttrs: !1
+})
+</script>
+
+<template>
+  <div
+    :class="{
+      'm--container' : !0,
+      'm--container__fluid' : (fluid !== !1 && fluid !== undefined) || (styles.fluid === !0 && (fluid !== !1 && fluid !== undefined)),
+      'm--container__dense' : dense !== !1 && dense !== undefined,
+      [`q-pa-${sizeProp||''}`]: sizeProp && sizeProp !== 'none'
+    }"
+    v-bind="$attrs"
+  >
+    <slot />
+  </div>
+</template>

package/src/components/grid/MHelpRow.vue

@@ -0,0 +1,62 @@
+<!--
+  - 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 { useI18n } from 'vue-i18n'
+
+interface Props {
+  text?: string | undefined;
+  icon?: string | undefined;
+  tooltip?: boolean | undefined;
+}
+
+defineProps<Props>()
+const { t, te } = useI18n({ useScope: 'global' })
+const __ = (s: any) => !s ? '' : te(`attributes.${s}`) ? t(`attributes.${s}`) : te(s) ? t(s) : s
+defineOptions({
+  name: 'MHelpRow',
+  inheritAttrs: !1
+})
+</script>
+
+<template>
+  <div class="row">
+    <div class="col-auto">
+      <q-icon
+        :left="!!text && !tooltip"
+        class="cursor-pointer"
+        name="ion-ios-information-circle-outline"
+        size="19px"
+      >
+        <q-tooltip
+          v-if="!!tooltip"
+          anchor="center end"
+          class="bg-transparent text-black text-justify"
+          self="center start"
+          transition-hide="jump-right"
+          transition-show="jump-left"
+        >
+          <q-card style="max-width: 280px">
+            <q-card-section style="font-size: 13px">
+              {{ __(text) }}
+            </q-card-section>
+          </q-card>
+        </q-tooltip>
+      </q-icon>
+    </div>
+    <div
+      v-if="!tooltip && !!text"
+      class="col"
+    >
+      <div v-text="__(text)" />
+    </div>
+  </div>
+</template>

package/src/components/grid/MRow.vue

@@ -0,0 +1,35 @@
+<script
+  lang="ts"
+  setup
+>
+import type { MRowProps } from '../../types'
+import { computed } from 'vue'
+import MythOptions from '../../utils'
+
+interface Props {
+  gutter?: MRowProps['gutter'];
+  col?: MRowProps['col'];
+}
+
+const props = defineProps<Props>()
+const defSize = computed<string>(() => MythOptions.defaults.value.style?.gutters || '')
+const gutterSize = computed<string>(() => props.gutter === !0 ? defSize.value : (props.gutter || defSize.value))
+const colSize = computed<string>(() => props.gutter === !0 ? defSize.value : (props.gutter || defSize.value))
+defineOptions({
+  name: 'MRow',
+  inheritAttrs: !1
+})
+</script>
+
+<template>
+  <div
+    :class="{
+      'm--row row': !0,
+      [`q-gutter-${gutterSize}`]: gutter !== !1 && gutter !== undefined,
+      [`q-col-gutter-${colSize}`]: col !== !1 && col !== undefined,
+    }"
+    v-bind="$attrs"
+  >
+    <slot />
+  </div>
+</template>

package/src/components/typography/MTypingString.vue

@@ -0,0 +1,78 @@
+<script
+  lang="ts"
+  setup
+>
+
+import Typed, { type TypedOptions } from 'typed.js'
+import { computed, onBeforeUnmount, onMounted, watch } from 'vue'
+import type { MTypingStringProps } from '../../types'
+
+interface Props {
+  name: MTypingStringProps['name'];
+  tag?: MTypingStringProps['tag'];
+  string: MTypingStringProps['string'];
+  loop?: MTypingStringProps['loop'];
+  typeSpeed?: MTypingStringProps['typeSpeed'];
+  backDelay?: MTypingStringProps['backDelay'];
+  fadeOut?: MTypingStringProps['fadeOut'];
+  options?: MTypingStringProps['options'];
+}
+
+const props = defineProps<Props>()
+
+const elmId = computed(() => `typed-content-${props.name}`)
+const computedOptions = computed(() => ({
+  loop: props.loop === undefined ? !1 : props.loop,
+  typeSpeed: props.typeSpeed === undefined ? 300 : props.typeSpeed,
+  backDelay: props.backDelay,
+  fadeOut: props.fadeOut,
+  strings: typeof props.string === 'string' ? [props.string] : props.string,
+  ...props.options
+} as TypedOptions))
+let typed: Typed | undefined
+const iniTyped = () => {
+  try {
+    typed = new Typed(`#${elmId.value}`, computedOptions.value)
+  } catch (e) {
+    console.log(e)
+  }
+}
+const destroy = () => {
+  if (typed) {
+    try {
+      typed.destroy()
+    } catch (e) {
+
+    }
+  }
+}
+watch(() => props.string, () => {
+  destroy()
+  iniTyped()
+})
+onMounted(() => {
+  if (props.string) {
+    try {
+      iniTyped()
+    } catch (e) {
+      console.log(e)
+      const a = document.getElementById(elmId.value)
+      a && (a.innerHTML = typeof props.string === 'string' ? props.string : props.string.join('<br />'))
+    }
+  }
+})
+onBeforeUnmount(() => destroy())
+defineExpose({ typed })
+defineOptions({
+  name: 'MTypingString',
+  inheritAttrs: !1
+})
+</script>
+
+<template>
+  <component
+    :is="tag || 'span'"
+    :id="elmId"
+    v-bind="$attrs"
+  />
+</template>

package/src/index.sass

@@ -1,2 +1,27 @@
 @import 'quasar/src/css/variables.sass'
+$m--container-padding: $space-base !default
+$m--container-fluid-width: 1440px !default
+$m--row-margin-top: $m--container-padding !default
 
+.flex-break
+  flex: 1 0 100% !important
+
+.row
+  .flex-break
+    height: 0 !important
+
+.column
+  .flex-break
+    width: 0 !important
+
+.m--container
+  &__dense
+    padding: 0 !important
+
+  &__fluid
+    max-width: $m--container-fluid-width
+    margin-left: auto
+    margin-right: auto
+
+.m--row + .m--row
+  margin-top: $m--row-margin-top

package/src/types/VuePlugin.d.ts

@@ -1,9 +1,24 @@
 import type { QBtnProps } from 'quasar'
 import type { Ref } from 'vue'
-import { MBlockProps } from './components'
+import type { MBlockProps, StyleSize } from './components'
 
 export interface UiOptions {
-  style?: Record<string, any>;
+  /**
+   * Style of the components.
+   */
+  style?: {
+    /**
+     * Apply Padding on all sides of components.
+     */
+    gutters?: StyleSize | undefined;
+    /**
+     * Apply Fluid on all sides of containers.
+     */
+    fluid?: boolean | undefined;
+  };
+  /**
+   * MBtn component.
+   */
   btn?: {
     props?: Partial<QBtnProps>;
     loading?: {
@@ -13,6 +28,9 @@ export interface UiOptions {
       label?: boolean | undefined;
     }
   };
+  /**
+   * MBlock component.
+   */
   block?: Partial<MBlockProps>;
 }
 

package/src/types/components.d.ts

@@ -1,5 +1,8 @@
-import type { GlobalComponentConstructor, QBtnProps, QBtnSlots } from 'quasar'
+import type { GlobalComponentConstructor, QBtnProps, QBtnSlots, QItemProps } from 'quasar'
 import type { VNode } from 'vue'
+import { TypedOptions } from 'typed.js'
+
+export type StyleSize = 'xs' | 'sm' | 'md' | 'lg' | 'xl' | 'none';
 
 export interface MBtnProps extends QBtnProps {
   //
@@ -21,7 +24,7 @@ export interface MBlockProps {
    * Size of the padding block.
    * Default: 'md'
    */
-  readonly size?: 'none' | 'xs' | 'sm' | 'md' | 'lg' | 'xl' | undefined;
+  readonly size?: StyleSize | undefined;
   /**
    * Rounded block
    */
@@ -33,12 +36,128 @@ export interface MBlockProps {
 }
 
 export interface MBlockSlots {
-  default?: () => VNode[];
+  default: () => VNode[];
+}
+
+export type ColStyleType =
+  boolean
+  | undefined
+  | string
+  | number
+  | 'auto'
+  | 'grow'
+  | 'shrink'
+  | '1'
+  | '2'
+  | '3'
+  | '4'
+  | '5'
+  | '6'
+  | '7'
+  | '8'
+  | '9'
+  | '10'
+  | '11'
+  | '12'
+  | 1
+  | 2
+  | 3
+  | 4
+  | 5
+  | 6
+  | 7
+  | 8
+  | 9
+  | 10
+  | 11
+  | 12
+
+export interface MColProps {
+  readonly auto?: boolean | undefined;
+  readonly col?: ColStyleType;
+  readonly xs?: ColStyleType;
+  readonly sm?: ColStyleType;
+  readonly md?: ColStyleType;
+  readonly lg?: ColStyleType;
+  readonly xl?: ColStyleType;
+  readonly name?: string;
+}
+
+export interface MColSlots {
+  default: () => VNode[];
+}
+
+export interface MColumnProps {
+  [key: string]: any;
+}
+
+export interface MColumnSlots {
+  default: () => VNode[];
+}
+
+export interface MContainerProps {
+  readonly size?: StyleSize | string | undefined;
+  readonly dense?: boolean | undefined;
+  readonly fluid?: boolean | undefined;
+}
+
+export interface MContainerSlots {
+  default: () => VNode[];
+}
+
+export interface MRowProps {
+  /**
+   * Default: false.
+   */
+  gutter?: boolean | StyleSize | undefined;
+  /**
+   * Default: false.
+   */
+  col?: boolean | StyleSize | undefined;
+}
+
+export interface MRowSlots {
+  default: () => VNode[];
+}
+
+export interface MHelpRowProps extends Partial<QItemProps> {
+  text?: string | undefined;
+  icon?: string | undefined;
+  tooltip?: boolean | undefined;
+}
+
+export interface MHelpRowSlots {
+  default: () => VNode[];
+}
+
+export interface MTypingStringProps {
+  name: number | string;
+  tag?: string;
+  string: string | string[];
+  loop?: TypedOptions['loop'];
+  typeSpeed?: TypedOptions['typeSpeed'];
+  backDelay?: TypedOptions['backDelay'];
+  fadeOut?: TypedOptions['fadeOut'];
+  options?: Omit<TypedOptions, 'loop' | 'typeSpeed' | 'backDelay' | 'fadeOut'>;
+}
+
+export interface MTypingStringSlots {
+  default: () => VNode[];
 }
 
 declare module '@vue/runtime-core' {
   interface GlobalComponents {
+    // Form.
     MBtn: GlobalComponentConstructor<MBtnProps, MBtnSlots>;
+
+    // Grid.
     MBlock: GlobalComponentConstructor<MBlockProps, MBlockSlots>;
+    MCol: GlobalComponentConstructor<MColProps, MColSlots>;
+    MColumn: GlobalComponentConstructor<MColumnProps, MColumnSlots>;
+    MContainer: GlobalComponentConstructor<MContainerProps, MContainerSlots>;
+    MHelpRow: GlobalComponentConstructor<MHelpRowProps, MHelpRowSlots>;
+    MRow: GlobalComponentConstructor<MRowProps, MRowSlots>;
+    // Typography.
+    MTypingString: GlobalComponentConstructor<MTypingStringProps, MTypingStringSlots>;
   }
 }

package/src/utils.ts

@@ -1,15 +1,22 @@
 import { ref } from 'vue'
-import type { UiOptions } from './types'
 import type { QBtnProps } from 'quasar'
+import { extend } from 'quasar'
+import type { UiOptions } from './types'
 
-const cmDefaults = ref<UiOptions>({})
+const defGutters = 'md'
+const defaultOptions: UiOptions = {
+  style: {
+    gutters: defGutters
+  }
+}
+const cmDefaults = ref<UiOptions>({ ...defaultOptions })
 const MythOptions = {
   defaults: cmDefaults,
   setDefaults (values: Partial<UiOptions>) {
-    cmDefaults.value = { ...values }
+    cmDefaults.value = extend(!0, defaultOptions, values)
   },
   withDefaults (values: Partial<UiOptions>) {
-    cmDefaults.value = { ...cmDefaults.value, ...values }
+    cmDefaults.value = extend(!0, defaultOptions, cmDefaults.value, values)
   },
   withBtnDefaults (values: Partial<QBtnProps>) {
     cmDefaults.value = {

package/src/vue-plugin.js

@@ -1,22 +1,38 @@
-import MBtn from './components/form/MBtn.vue'
 import js from '../package.json'
 import { MythOptions } from './utils'
+import MBtn from './components/form/MBtn.vue'
 import MBlock from './components/grid/MBlock.vue'
+import MCol from './components/grid/MCol.vue'
+import MColumn from './components/grid/MColumn.vue'
+import MContainer from './components/grid/MContainer.vue'
+import MHelpRow from './components/grid/MHelpRow.vue'
+import MRow from './components/grid/MRow.vue'
+import MTypingString from './components/typography/MTypingString.vue'
 
 const name = js.name
 const version = js.version
 
 function install (app, options = {}) {
   MythOptions.withDefaults(options)
+  // Form.
   app.component('MBtn', MBtn)
+
+  // Grid.
   app.component('MBlock', MBlock)
+  app.component('MCol', MCol)
+  app.component('MColumn', MColumn)
+  app.component('MContainer', MContainer)
+  app.component('MHelpRow', MHelpRow)
+  app.component('MRow', MRow)
+
+  // Typography.
+  app.component('MTypingString', MTypingString)
 }
 
 export {
   name,
   version,
-  install,
-  MythOptions
+  install
 }
 
 export default {

package/tsconfig.json

@@ -1,10 +1,28 @@
 {
   "compilerOptions": {
-    "target": "ESNext",
-    "module": "Preserve",
     "esModuleInterop": true,
-    "forceConsistentCasingInFileNames": true,
+    "skipLibCheck": true,
+    "target": "esnext",
+    "allowJs": true,
+    "resolveJsonModule": true,
+    "moduleDetection": "force",
+    "isolatedModules": true,
+    "verbatimModuleSyntax": true,
+    "module": "preserve",
+    "noEmit": true,
+    "lib": [
+      "esnext",
+      "dom",
+      "dom.iterable"
+    ],
     "strict": true,
-    "skipLibCheck": true
-  }
+    "allowUnreachableCode": false,
+    "allowUnusedLabels": false,
+    "noImplicitOverride": true,
+    "exactOptionalPropertyTypes": true,
+    "noUncheckedIndexedAccess": true,
+  },
+  "exclude": [
+    "./build"
+  ]
 }

package/src/utils.js

@@ -1,22 +0,0 @@
-import { ref } from 'vue';
-const cmDefaults = ref({});
-const MythOptions = {
-    defaults: cmDefaults,
-    setDefaults(values) {
-        cmDefaults.value = { ...values };
-    },
-    withDefaults(values) {
-        cmDefaults.value = { ...cmDefaults.value, ...values };
-    },
-    withBtnDefaults(values) {
-        cmDefaults.value = {
-            ...cmDefaults.value,
-            btn: {
-                ...cmDefaults.value.btn,
-                props: { ...values }
-            }
-        };
-    }
-};
-export default MythOptions;
-export { MythOptions };