@bobbykim/mcl-collapse 0.2.0

package/CHANGELOG.md

@@ -0,0 +1,13 @@
+# Change Log
+
+All notable changes to this project will be documented in this file.
+See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
+
+# 0.2.0 (2024-02-27)
+
+
+### Features
+
+* **mcl-collapse:** add mcl-collapse component library and add story for mcl-collapse-a ([397b63e](https://github.com/bobbykim89/manguito-component-library/commit/397b63e00b83801bdf1cd2c6710d0ba876c6bf87))
+* **mcl-collapse:** add story for mcl-collapse-b ([6edbc56](https://github.com/bobbykim89/manguito-component-library/commit/6edbc569833aae3f1aef65634987157b38956f83))
+* **stories:** add story for mcl-card-b ([7470f0d](https://github.com/bobbykim89/manguito-component-library/commit/7470f0ddee5b3ba3c9f5c37e52bd37f6a1a75202))

package/LICENSE.md

@@ -0,0 +1,9 @@
+MIT License
+
+Copyright (c) 2022 Bobby Kim
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/README.md

@@ -0,0 +1,21 @@
+# @bobbykim/mcl-collapse
+
+Add description
+
+## Demo
+
+[MCL Histoire Page](https://manguito-component-library.vercel.app/story/{%story-link%})
+
+## Install
+
+## Usage
+
+`import MclCollapse from "@bobbykim/mcl-collapse"`;
+
+## Maintainer
+
+- **Bobby Kim** - _Initial work_
+
+## License
+
+This project is licensed under the MIT License - see the [LICENSE.md](./LICENSE.md) file for details

package/index.d.ts

@@ -0,0 +1,3 @@
+import MclCollapseA from './lib/mcl-collapse-a/MclCollapseA.vue';
+import MclCollapseB from './lib/mcl-collapse-b/MclCollapseB.vue';
+export { MclCollapseA, MclCollapseB };

package/index.js

@@ -0,0 +1,3 @@
+import MclCollapseA from './lib/mcl-collapse-a/MclCollapseA.vue';
+import MclCollapseB from './lib/mcl-collapse-b/MclCollapseB.vue';
+export { MclCollapseA, MclCollapseB };

package/index.ts

@@ -0,0 +1,4 @@
+import MclCollapseA from './lib/mcl-collapse-a/MclCollapseA.vue'
+import MclCollapseB from './lib/mcl-collapse-b/MclCollapseB.vue'
+
+export { MclCollapseA, MclCollapseB }

package/lib/mcl-collapse-a/MclCollapseA.vue

@@ -0,0 +1,158 @@
+<script setup lang="ts">
+import { ref, watch } from 'vue'
+import generateClass, { Collapse, vCollapse } from '@bobbykim/manguito-theme'
+import type { CollapseEvent } from '@bobbykim/manguito-theme'
+import type { ColorPalette, HeadingSize } from '@bobbykim/manguito-theme'
+
+const props = withDefaults(
+  defineProps<{
+    collapseId: string
+    borderColor?: ColorPalette
+    rounded?: boolean
+    displayHighlight?: boolean
+    highlightColor?: ColorPalette
+    title: string
+    titleSize?: HeadingSize
+    titleColor?: ColorPalette
+    visible?: boolean
+    iconColor?: ColorPalette
+    bgColor?: ColorPalette
+    slotBgColor?: ColorPalette
+    accordion?: string
+  }>(),
+  {
+    borderColor: 'light-4',
+    rounded: false,
+    displayHighlight: true,
+    highlightColor: 'secondary',
+    titleSize: 'sm',
+    titleColor: 'dark-3',
+    visible: false,
+    iconColor: 'dark-3',
+    bgColor: 'white',
+    slotBgColor: 'light-2',
+  }
+)
+
+const toggle = ref(props.visible)
+const emit = defineEmits(['collapse-open', 'collapse-close'])
+
+const toggleAction = (e: CollapseEvent): void => {
+  toggle.value = e.visible
+  if (e.visible === true) {
+    emit('collapse-open', { ...e, title: props.title })
+  } else {
+    emit('collapse-close', { ...e, title: props.title })
+  }
+}
+
+const getBorderClass = (
+  bColor: ColorPalette,
+  dHl: boolean,
+  hlColor: ColorPalette
+): string => {
+  /**
+   * @param {ColorPalette} bColor - borderColor
+   * @param {boolean} dHl - displayHighlight
+   * @param {ColorPalette} hlColor - highlightColor
+   */
+
+  const classArray: string[] = ['border', generateClass('BORDER', bColor)]
+
+  if (dHl) {
+    const borderArray: string[] = [generateClass('BORDERL', hlColor)]
+    borderArray.forEach((item) => {
+      classArray.push(item), classArray.push('border-l-8')
+    })
+  }
+
+  return classArray.join(' ')
+}
+
+const getTitleClass = (size: HeadingSize, color: ColorPalette): string => {
+  /**
+   * @param {HeadingSize} size - titleSize
+   * @param {ColorPalette} color - titleColor
+   */
+  const classArray: string[] = [
+    generateClass('H3', size),
+    generateClass('TEXTCOLOR', color),
+  ]
+  return classArray.join(' ')
+}
+
+watch(
+  () => props.visible,
+  (newValue) => {
+    toggle.value = newValue
+  }
+)
+</script>
+
+<template>
+  <div
+    class="overflow-hidden w-full"
+    :class="[
+      rounded ? 'rounded-lg' : 'rounded-sm',
+      getBorderClass(borderColor, displayHighlight, highlightColor),
+    ]"
+  >
+    <div
+      class="py-xs px-sm cursor-pointer transition-[border] duration-500"
+      :class="[
+        toggle
+          ? `border-b ${generateClass('BORDERB', borderColor)} ease-in`
+          : 'ease-out',
+        generateClass('BGCOLOR', bgColor),
+      ]"
+      v-collapse:[collapseId]
+    >
+      <div class="flex justify-between items-center">
+        <h3 :class="getTitleClass(titleSize, titleColor)">
+          {{ title }}
+        </h3>
+        <div @click.stop class="cursor-default">
+          <slot name="tab"></slot>
+        </div>
+      </div>
+    </div>
+    <div class="overflow-hidden" :class="generateClass('BGCOLOR', slotBgColor)">
+      <collapse
+        :id="collapseId"
+        :visible="visible"
+        class-name="py-sm px-xs"
+        @open="toggleAction"
+        @close="toggleAction"
+        :accordion="accordion"
+      >
+        <slot name="content"></slot>
+      </collapse>
+    </div>
+    <div
+      class="py-1.5 px-sm cursor-pointer transition-all duration-500 flex justify-center items-center border-t"
+      :class="[
+        generateClass('BGCOLOR', bgColor),
+        generateClass('BORDERT', borderColor),
+      ]"
+      v-collapse:[collapseId]
+    >
+      <svg
+        xmlns="http://www.w3.org/2000/svg"
+        viewBox="0 0 448 512"
+        class="h-xs"
+        :class="[
+          !toggle ? 'rotate-0' : 'rotate-180',
+          'transition-transform duration-300 ease-in',
+          generateClass('SVGFILL', iconColor),
+        ]"
+      >
+        <!--! Font Awesome Pro 6.1.1 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license (Commercial License) Copyright 2022 Fonticons, Inc. -->
+        <path
+          d="M224 416c-8.188 0-16.38-3.125-22.62-9.375l-192-192c-12.5-12.5-12.5-32.75 0-45.25s32.75-12.5 45.25 0L224 338.8l169.4-169.4c12.5-12.5 32.75-12.5 45.25 0s12.5 32.75 0 45.25l-192 192C240.4 412.9 232.2 416 224 416z"
+        />
+      </svg>
+    </div>
+  </div>
+</template>
+
+<style lang="scss" scoped></style>

package/lib/mcl-collapse-a/MclCollapseA.vue.d.ts

@@ -0,0 +1,95 @@
+import type { ColorPalette, HeadingSize } from '@bobbykim/manguito-theme';
+declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<__VLS_WithDefaults<__VLS_TypePropsToRuntimeProps<{
+    collapseId: string;
+    borderColor?: ColorPalette | undefined;
+    rounded?: boolean | undefined;
+    displayHighlight?: boolean | undefined;
+    highlightColor?: ColorPalette | undefined;
+    title: string;
+    titleSize?: HeadingSize | undefined;
+    titleColor?: ColorPalette | undefined;
+    visible?: boolean | undefined;
+    iconColor?: ColorPalette | undefined;
+    bgColor?: ColorPalette | undefined;
+    slotBgColor?: ColorPalette | undefined;
+    accordion?: string | undefined;
+}>, {
+    borderColor: string;
+    rounded: boolean;
+    displayHighlight: boolean;
+    highlightColor: string;
+    titleSize: string;
+    titleColor: string;
+    visible: boolean;
+    iconColor: string;
+    bgColor: string;
+    slotBgColor: string;
+}>, {}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
+    "collapse-open": (...args: any[]) => void;
+    "collapse-close": (...args: any[]) => void;
+}, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<__VLS_WithDefaults<__VLS_TypePropsToRuntimeProps<{
+    collapseId: string;
+    borderColor?: ColorPalette | undefined;
+    rounded?: boolean | undefined;
+    displayHighlight?: boolean | undefined;
+    highlightColor?: ColorPalette | undefined;
+    title: string;
+    titleSize?: HeadingSize | undefined;
+    titleColor?: ColorPalette | undefined;
+    visible?: boolean | undefined;
+    iconColor?: ColorPalette | undefined;
+    bgColor?: ColorPalette | undefined;
+    slotBgColor?: ColorPalette | undefined;
+    accordion?: string | undefined;
+}>, {
+    borderColor: string;
+    rounded: boolean;
+    displayHighlight: boolean;
+    highlightColor: string;
+    titleSize: string;
+    titleColor: string;
+    visible: boolean;
+    iconColor: string;
+    bgColor: string;
+    slotBgColor: string;
+}>>> & {
+    "onCollapse-open"?: ((...args: any[]) => any) | undefined;
+    "onCollapse-close"?: ((...args: any[]) => any) | undefined;
+}, {
+    visible: boolean;
+    titleColor: ColorPalette;
+    borderColor: ColorPalette;
+    rounded: boolean;
+    displayHighlight: boolean;
+    highlightColor: ColorPalette;
+    titleSize: HeadingSize;
+    iconColor: ColorPalette;
+    bgColor: ColorPalette;
+    slotBgColor: ColorPalette;
+}, {}>, {
+    tab?(_: {}): any;
+    content?(_: {}): any;
+}>;
+export default _default;
+type __VLS_NonUndefinedable<T> = T extends undefined ? never : T;
+type __VLS_TypePropsToRuntimeProps<T> = {
+    [K in keyof T]-?: {} extends Pick<T, K> ? {
+        type: import('vue').PropType<__VLS_NonUndefinedable<T[K]>>;
+    } : {
+        type: import('vue').PropType<T[K]>;
+        required: true;
+    };
+};
+type __VLS_WithDefaults<P, D> = {
+    [K in keyof Pick<P, keyof P>]: K extends keyof D ? __VLS_Prettify<P[K] & {
+        default: D[K];
+    }> : P[K];
+};
+type __VLS_Prettify<T> = {
+    [K in keyof T]: T[K];
+} & {};
+type __VLS_WithTemplateSlots<T, S> = T & {
+    new (): {
+        $slots: S;
+    };
+};

package/lib/mcl-collapse-b/MclCollapseB.vue

@@ -0,0 +1,145 @@
+<script setup lang="ts">
+import { ref, watch } from 'vue'
+import generateClass, { Collapse, vCollapse } from '@bobbykim/manguito-theme'
+import type { CollapseEvent } from '@bobbykim/manguito-theme'
+import type { ColorPalette, HeadingSize } from '@bobbykim/manguito-theme'
+
+const props = withDefaults(
+  defineProps<{
+    collapseId: string
+    title: string
+    titleColor?: ColorPalette
+    titleSize?: HeadingSize
+    borderColor?: ColorPalette
+    bgColor?: ColorPalette
+    btnColor?: ColorPalette
+    iconColor?: ColorPalette
+    rounded?: boolean
+    displayShadow?: boolean
+    visible?: boolean
+    accordion?: string
+  }>(),
+  {
+    titleColor: 'light-1',
+    titleSize: 'md',
+    borderColor: 'light-3',
+    bgColor: 'light-1',
+    btnColor: 'primary',
+    iconColor: 'light-1',
+    rounded: true,
+    displayShadow: true,
+    visible: false,
+  }
+)
+
+const toggle = ref(props.visible)
+const emit = defineEmits(['collapse-open', 'collapse-close'])
+
+const toggleAction = (e: CollapseEvent): void => {
+  toggle.value = e.visible
+  if (e.visible === true) {
+    emit('collapse-open', { ...e, title: props.title })
+  } else {
+    emit('collapse-close', { ...e, title: props.title })
+  }
+}
+
+const getBorderClass = (
+  bColor: ColorPalette,
+  bgColor: ColorPalette,
+  rounded: boolean,
+  dShadow: boolean
+): string => {
+  /**
+   * @param {ColorPalette} bColor - borderColor
+   * @param {ColorPalette} bgColor - bgColor
+   * @param {boolean} rounded - rounded
+   * @param {boolean} dShadow - displayShadow
+   */
+
+  let borderInfo: string[] = [
+    'border',
+    generateClass('BORDER', bColor),
+    generateClass('BGCOLOR', bgColor),
+  ]
+
+  if (dShadow) {
+    borderInfo.push('shadow-md')
+  }
+  if (rounded) {
+    borderInfo.push('rounded-2xl')
+  } else {
+    borderInfo.push('rounded-sm')
+  }
+
+  return borderInfo.join(' ')
+}
+
+const getTitleClass = (size: HeadingSize, color: ColorPalette): string => {
+  /**
+   * @param {HeadingSize} size - titleSize
+   * @param {ColorPalette} color - titleColor
+   */
+
+  const classArray: string[] = [
+    generateClass('H3', size),
+    generateClass('TEXTCOLOR', color),
+  ]
+  return classArray.join(' ')
+}
+
+watch(
+  () => props.visible,
+  (newValue) => {
+    toggle.value = newValue
+  }
+)
+</script>
+
+<template>
+  <div
+    class="w-full overflow-hidden p-2xs"
+    :class="getBorderClass(borderColor, bgColor, rounded, displayShadow)"
+  >
+    <div
+      v-collapse:[collapseId]
+      class="flex justify-between items-center w-full px-4 py-2 cursor-pointer hover:bg-opacity-70 transition duration-200 ease-in"
+      :class="[
+        rounded ? 'rounded-lg' : 'rounded-sm',
+        generateClass('BGCOLOR', btnColor),
+      ]"
+    >
+      <h3 :class="getTitleClass(titleSize, titleColor)">{{ title }}</h3>
+      <div class="flex justify-center items-center ml-xs md:ml-sm lg:ml-md">
+        <svg
+          xmlns="http://www.w3.org/2000/svg"
+          viewBox="0 0 448 512"
+          class="h-xs transition-transform duration-300 ease-in"
+          :class="[
+            !toggle ? 'rotate-0' : 'rotate-180',
+            generateClass('SVGFILL', iconColor),
+          ]"
+        >
+          <!--! Font Awesome Pro 6.1.1 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license (Commercial License) Copyright 2022 Fonticons, Inc. -->
+          <path
+            d="M224 416c-8.188 0-16.38-3.125-22.62-9.375l-192-192c-12.5-12.5-12.5-32.75 0-45.25s32.75-12.5 45.25 0L224 338.8l169.4-169.4c12.5-12.5 32.75-12.5 45.25 0s12.5 32.75 0 45.25l-192 192C240.4 412.9 232.2 416 224 416z"
+          />
+        </svg>
+      </div>
+    </div>
+    <div class="overflow-hidden">
+      <collapse
+        :id="collapseId"
+        :visible="visible"
+        class-name="px-xs pt-xs pb-2xs"
+        :accordion="accordion"
+        @open="toggleAction"
+        @close="toggleAction"
+      >
+        <slot></slot>
+      </collapse>
+    </div>
+  </div>
+</template>
+
+<style lang="scss" scoped></style>

package/lib/mcl-collapse-b/MclCollapseB.vue.d.ts

@@ -0,0 +1,89 @@
+import type { ColorPalette, HeadingSize } from '@bobbykim/manguito-theme';
+declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<__VLS_WithDefaults<__VLS_TypePropsToRuntimeProps<{
+    collapseId: string;
+    title: string;
+    titleColor?: ColorPalette | undefined;
+    titleSize?: HeadingSize | undefined;
+    borderColor?: ColorPalette | undefined;
+    bgColor?: ColorPalette | undefined;
+    btnColor?: ColorPalette | undefined;
+    iconColor?: ColorPalette | undefined;
+    rounded?: boolean | undefined;
+    displayShadow?: boolean | undefined;
+    visible?: boolean | undefined;
+    accordion?: string | undefined;
+}>, {
+    titleColor: string;
+    titleSize: string;
+    borderColor: string;
+    bgColor: string;
+    btnColor: string;
+    iconColor: string;
+    rounded: boolean;
+    displayShadow: boolean;
+    visible: boolean;
+}>, {}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
+    "collapse-open": (...args: any[]) => void;
+    "collapse-close": (...args: any[]) => void;
+}, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<__VLS_WithDefaults<__VLS_TypePropsToRuntimeProps<{
+    collapseId: string;
+    title: string;
+    titleColor?: ColorPalette | undefined;
+    titleSize?: HeadingSize | undefined;
+    borderColor?: ColorPalette | undefined;
+    bgColor?: ColorPalette | undefined;
+    btnColor?: ColorPalette | undefined;
+    iconColor?: ColorPalette | undefined;
+    rounded?: boolean | undefined;
+    displayShadow?: boolean | undefined;
+    visible?: boolean | undefined;
+    accordion?: string | undefined;
+}>, {
+    titleColor: string;
+    titleSize: string;
+    borderColor: string;
+    bgColor: string;
+    btnColor: string;
+    iconColor: string;
+    rounded: boolean;
+    displayShadow: boolean;
+    visible: boolean;
+}>>> & {
+    "onCollapse-open"?: ((...args: any[]) => any) | undefined;
+    "onCollapse-close"?: ((...args: any[]) => any) | undefined;
+}, {
+    visible: boolean;
+    titleColor: ColorPalette;
+    borderColor: ColorPalette;
+    rounded: boolean;
+    titleSize: HeadingSize;
+    iconColor: ColorPalette;
+    bgColor: ColorPalette;
+    btnColor: ColorPalette;
+    displayShadow: boolean;
+}, {}>, {
+    default?(_: {}): any;
+}>;
+export default _default;
+type __VLS_NonUndefinedable<T> = T extends undefined ? never : T;
+type __VLS_TypePropsToRuntimeProps<T> = {
+    [K in keyof T]-?: {} extends Pick<T, K> ? {
+        type: import('vue').PropType<__VLS_NonUndefinedable<T[K]>>;
+    } : {
+        type: import('vue').PropType<T[K]>;
+        required: true;
+    };
+};
+type __VLS_WithDefaults<P, D> = {
+    [K in keyof Pick<P, keyof P>]: K extends keyof D ? __VLS_Prettify<P[K] & {
+        default: D[K];
+    }> : P[K];
+};
+type __VLS_Prettify<T> = {
+    [K in keyof T]: T[K];
+} & {};
+type __VLS_WithTemplateSlots<T, S> = T & {
+    new (): {
+        $slots: S;
+    };
+};

package/package.json

@@ -0,0 +1,27 @@
+{
+  "name": "@bobbykim/mcl-collapse",
+  "version": "0.2.0",
+  "description": "",
+  "type": "module",
+  "main": "index.ts",
+  "scripts": {
+    "build": "vue-tsc --project tsconfig.vue.json && tsc"
+  },
+  "author": {
+    "name": "Bobby Kim",
+    "url": "https://www.devbobbykim.com/"
+  },
+  "homepage": "https://manguito-component-library.vercel.app/",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/bobbykim89/manguito-component-library.git"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "license": "MIT",
+  "dependencies": {
+    "@bobbykim/manguito-theme": "^0.14.0"
+  },
+  "gitHead": "4d94a8d34988d926c8d465891fd7aa535cffdf33"
+}

package/tsconfig.json

@@ -0,0 +1,9 @@
+{
+"extends": "../../../tsconfig.json",
+"include": ["./**/*.ts"],
+"exclude": ["node_modules", "./**/*.vue.d.ts", "./**/*.vue"],
+"compilerOptions": {
+"skipLibCheck": true,
+"declaration": true
+}
+}

package/tsconfig.vue.json

@@ -0,0 +1,9 @@
+{
+"extends": "../../../tsconfig.json",
+"include": ["./**/*.vue"],
+"exclude": ["node_modules"],
+"compilerOptions": {
+"declaration": true,
+"emitDeclarationOnly": true
+}
+}