@bobbykim/mcl-carousel 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
+
+* **manguito-theme,mcl-cards,mcl-header,mcl-footer,mcl-carousel:** add vueuse as one of dependencies, update code to make them ssr friendly ([119a327](https://github.com/bobbykim89/manguito-component-library/commit/119a327adf1ca9866e6ac063bce5acd4790db612))
+* **mcl-carousel:** add mcl-carousel package ([6e03649](https://github.com/bobbykim89/manguito-component-library/commit/6e03649aaf8aca8902db71dcc60e38d75a1533fd))
+* **stories/*:** ran package:build to build type declaration, move deprecated story files into deprecated folder ([ffc487d](https://github.com/bobbykim89/manguito-component-library/commit/ffc487dbcc093be7a3ccfeae98c5e10e8372a0e3))

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-carousel
+
+Add description
+
+## Demo
+
+[MCL Histoire Page](https://manguito-component-library.vercel.app/story/{%story-link%})
+
+## Install
+
+## Usage
+
+`import MclCarousel from "@bobbykim/mcl-carousel"`;
+
+## 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,2 @@
+import MclCarouselA from './lib/mcl-carousel-a/MclCarouselA.vue';
+export { MclCarouselA };

package/index.js

@@ -0,0 +1,2 @@
+import MclCarouselA from './lib/mcl-carousel-a/MclCarouselA.vue';
+export { MclCarouselA };

package/index.ts

@@ -0,0 +1,3 @@
+import MclCarouselA from './lib/mcl-carousel-a/MclCarouselA.vue'
+
+export { MclCarouselA }

package/lib/mcl-carousel-a/MclCarouselA.vue

@@ -0,0 +1,292 @@
+<script setup lang="ts">
+import type {
+  BodyText,
+  ColorPalette,
+  HeadingSize,
+  SpacingLevel,
+} from '@bobbykim/manguito-theme'
+import generateClass from '@bobbykim/manguito-theme'
+import { MclCardA, MclCardB, MclCardC, MclCardD } from '@bobbykim/mcl-cards'
+import { onBeforeUnmount, onMounted, ref } from 'vue'
+
+type BtnNav = 'prev' | 'next'
+
+const props = withDefaults(
+  defineProps<{
+    title: string
+    titleSize?: HeadingSize
+    titleColor?: ColorPalette
+    bgColor?: ColorPalette
+    displayTagLine?: boolean
+    tagLineUpperCase?: boolean
+    tagLine?: string
+    tagLineSize?: BodyText
+    tagLineColor?: ColorPalette
+    displayHighlight?: boolean
+    highlightColor?: ColorPalette
+    btnColor?: ColorPalette
+    btnBgColor?: ColorPalette
+    content: any[]
+    cardsGap?: SpacingLevel
+  }>(),
+  {
+    titleSize: 'md',
+    titleColor: 'dark-3',
+    bgColor: 'light-1',
+    displayTagLine: true,
+    tagLineUpperCase: true,
+    tagLineSize: 'md',
+    tagLineColor: 'dark-1',
+    displayHighlight: true,
+    highlightColor: 'primary',
+    btnColor: 'dark-3',
+    btnBgColor: 'light-4',
+    cardsGap: 'xs',
+  }
+)
+const slideContainer = ref()
+const carouselCards = ref<
+  | null
+  | InstanceType<
+      typeof MclCardA | typeof MclCardB | typeof MclCardC | typeof MclCardD
+    >[]
+>([])
+const emit = defineEmits(['btn-prev', 'btn-next'])
+
+const currentIndex = ref(0)
+const isNextBtnDisabled = ref(false)
+let isMoving: boolean = false
+const cardsSpace = (gap: SpacingLevel): number => {
+  switch (gap) {
+    case '0':
+      return 0
+    case '3xs':
+      return 4
+    case '2xs':
+      return 8
+    case 'xs':
+      return 16
+    case 'sm':
+      return 24
+    case 'md':
+      return 32
+    case 'lg':
+      return 48
+    case 'xl':
+      return 64
+    case '2xl':
+      return 96
+    case '3xl':
+      return 128
+  }
+}
+
+// assign ref as
+const setCarouselRef = (el: any): void => {
+  carouselCards.value!.push(el)
+  // carouselCards.value = el
+}
+
+// navigation btn control function
+const handleSlideBtnClick = (e: Event, btn: BtnNav): void => {
+  if (isMoving) {
+    return
+  }
+  isMoving = true
+  // btn === 'prev' ? currentIndex.value-- : currentIndex.value++
+  if (btn === 'prev') {
+    currentIndex.value--
+    emit('btn-prev', e)
+  }
+  if (btn === 'next') {
+    currentIndex.value++
+    emit('btn-next', e)
+  }
+  slideContainer.value.dispatchEvent(new Event('sliderMove'))
+}
+
+// intersection observer
+const slideObserver = new IntersectionObserver(
+  (slide) => {
+    if (slide[0].isIntersecting) {
+      // add disable attribute
+      isNextBtnDisabled.value = true
+    }
+  },
+  { threshold: 0.75 }
+)
+
+const getTitleClass = (size: HeadingSize, color: ColorPalette): string => {
+  /**
+   * @size - titleSize
+   * @color - titleColor
+   */
+
+  const classArray = [
+    generateClass('H2', size),
+    generateClass('TEXTCOLOR', color),
+  ]
+
+  return classArray.join(' ')
+}
+
+const getTaglineClass = (
+  size: BodyText,
+  color: ColorPalette,
+  upper: boolean
+): string => {
+  /**
+   * @size - tagLineSize
+   * @color - tagLineColor
+   * @upper - tagLineUpperCase
+   */
+
+  const classArray = [
+    generateClass('BODYTEXT', size),
+    generateClass('TEXTCOLOR', color),
+  ]
+
+  if (upper) {
+    classArray.push('uppercase')
+  }
+
+  return classArray.join(' ')
+}
+
+const getButtonClass = (color: ColorPalette, bgColor: ColorPalette): string => {
+  /**
+   * @color - btnColor
+   * @bgColor - btnBgColor
+   */
+
+  const classArray = [
+    generateClass('TEXTCOLOR', color),
+    generateClass('BGCOLOR', bgColor),
+    generateClass('RINGCOLOR', bgColor),
+  ]
+
+  return classArray.join(' ')
+}
+
+const handleSlide = (): void => {
+  slideContainer.value.style.transform = `translateX(-${
+    currentIndex.value *
+    (carouselCards.value![0].$el.clientWidth + cardsSpace(props.cardsGap) + 2)
+  }px)`
+
+  isNextBtnDisabled.value = false
+}
+
+const handleTransitionEnd = (): void => {
+  isMoving = false
+}
+
+onMounted(() => {
+  // handle slide movement
+  slideContainer.value.addEventListener('sliderMove', handleSlide)
+  // handle transition end event
+  slideContainer.value.addEventListener('transitionend', handleTransitionEnd)
+  // intersection observer for slider
+  slideObserver.observe(
+    carouselCards.value![carouselCards.value!.length - 1].$el
+  )
+})
+
+onBeforeUnmount(() => {
+  slideContainer.value.removeEventListener('sliderMove', handleSlide)
+  slideContainer.value.removeEventListener('transitionend', handleTransitionEnd)
+  slideObserver.unobserve(
+    carouselCards.value![carouselCards.value!.length - 1].$el
+  )
+})
+</script>
+
+<template>
+  <section
+    class="py-lg lg:py-xl overflow-hidden"
+    :class="generateClass('BGCOLOR', bgColor)"
+  >
+    <div class="container px-xs sm:px-md text-center sm:text-left">
+      <div class="relative">
+        <div
+          v-if="displayHighlight"
+          class="hidden sm:block absolute w-md bg-opacity-25 -left-4 h-full"
+          :class="generateClass('BGCOLOR', highlightColor)"
+        ></div>
+        <div class="relative">
+          <span
+            v-if="displayTagLine"
+            class="tracking-widest"
+            :class="
+              getTaglineClass(tagLineSize, tagLineColor, tagLineUpperCase)
+            "
+            v-html="tagLine"
+          ></span>
+          <h2
+            class="tracking-wide"
+            :class="getTitleClass(titleSize, titleColor)"
+            v-html="title"
+          ></h2>
+        </div>
+        <div
+          class="relative flex flex-wrap sm:flex-nowrap justify-center sm:justify-start items-center space-x-4 space-y-4"
+        >
+          <div class="max-w-xl">
+            <slot name="description"></slot>
+          </div>
+          <div class="flex space-x-4">
+            <button
+              class="grid place-items-center hover:bg-opacity-80 rounded-full p-xs focus:outline-none focus:ring-4 ring-offset-2 ring-offset-inherit disabled:opacity-50 transition-all duration-200"
+              :class="getButtonClass(btnColor, btnBgColor)"
+              :disabled="currentIndex === 0"
+              @click="handleSlideBtnClick($event, 'prev')"
+              aria-label="previous"
+            >
+              <svg
+                class="w-xs h-xs"
+                xmlns="http://www.w3.org/2000/svg"
+                viewBox="0 0 384 512"
+                fill="currentColor"
+              >
+                <!--! Font Awesome Pro 6.2.1 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license (Commercial License) Copyright 2022 Fonticons, Inc. -->
+                <path
+                  d="M41.4 233.4c-12.5 12.5-12.5 32.8 0 45.3l192 192c12.5 12.5 32.8 12.5 45.3 0s12.5-32.8 0-45.3L109.3 256 278.6 86.6c12.5-12.5 12.5-32.8 0-45.3s-32.8-12.5-45.3 0l-192 192z"
+                />
+              </svg>
+            </button>
+            <button
+              class="grid place-items-center hover:bg-opacity-80 rounded-full p-xs focus:outline-none focus:ring-4 ring-offset-2 ring-offset-inherit disabled:opacity-50 transition-all duration-200"
+              :class="getButtonClass(btnColor, btnBgColor)"
+              :disabled="isNextBtnDisabled"
+              @click="handleSlideBtnClick($event, 'next')"
+              aria-label="next"
+            >
+              <svg
+                class="w-xs h-xs"
+                xmlns="http://www.w3.org/2000/svg"
+                viewBox="0 0 384 512"
+                fill="currentColor"
+              >
+                <!--! Font Awesome Pro 6.2.1 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license (Commercial License) Copyright 2022 Fonticons, Inc. -->
+                <path
+                  d="M342.6 233.4c12.5 12.5 12.5 32.8 0 45.3l-192 192c-12.5 12.5-32.8 12.5-45.3 0s-12.5-32.8 0-45.3L274.7 256 105.4 86.6c-12.5-12.5-12.5-32.8 0-45.3s32.8-12.5 45.3 0l192 192z"
+                />
+              </svg>
+            </button>
+          </div>
+        </div>
+      </div>
+    </div>
+    <div class="container mt-md sm:mt-lg lg:mt-xl">
+      <div
+        class="flex transition-transform duration-500 px-xs gap-xs"
+        :class="generateClass('GAP', cardsGap)"
+        ref="slideContainer"
+      >
+        <slot name="carousel" :cards="content" :set-ref="setCarouselRef"></slot>
+      </div>
+    </div>
+  </section>
+</template>
+
+<style lang="scss" scoped></style>

package/lib/mcl-carousel-a/MclCarouselA.vue.d.ts

@@ -0,0 +1,108 @@
+import type { BodyText, ColorPalette, HeadingSize, SpacingLevel } from '@bobbykim/manguito-theme';
+declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<__VLS_WithDefaults<__VLS_TypePropsToRuntimeProps<{
+    title: string;
+    titleSize?: HeadingSize | undefined;
+    titleColor?: ColorPalette | undefined;
+    bgColor?: ColorPalette | undefined;
+    displayTagLine?: boolean | undefined;
+    tagLineUpperCase?: boolean | undefined;
+    tagLine?: string | undefined;
+    tagLineSize?: BodyText | undefined;
+    tagLineColor?: ColorPalette | undefined;
+    displayHighlight?: boolean | undefined;
+    highlightColor?: ColorPalette | undefined;
+    btnColor?: ColorPalette | undefined;
+    btnBgColor?: ColorPalette | undefined;
+    content: any[];
+    cardsGap?: SpacingLevel | undefined;
+}>, {
+    titleSize: string;
+    titleColor: string;
+    bgColor: string;
+    displayTagLine: boolean;
+    tagLineUpperCase: boolean;
+    tagLineSize: string;
+    tagLineColor: string;
+    displayHighlight: boolean;
+    highlightColor: string;
+    btnColor: string;
+    btnBgColor: string;
+    cardsGap: string;
+}>, {}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
+    "btn-prev": (...args: any[]) => void;
+    "btn-next": (...args: any[]) => void;
+}, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<__VLS_WithDefaults<__VLS_TypePropsToRuntimeProps<{
+    title: string;
+    titleSize?: HeadingSize | undefined;
+    titleColor?: ColorPalette | undefined;
+    bgColor?: ColorPalette | undefined;
+    displayTagLine?: boolean | undefined;
+    tagLineUpperCase?: boolean | undefined;
+    tagLine?: string | undefined;
+    tagLineSize?: BodyText | undefined;
+    tagLineColor?: ColorPalette | undefined;
+    displayHighlight?: boolean | undefined;
+    highlightColor?: ColorPalette | undefined;
+    btnColor?: ColorPalette | undefined;
+    btnBgColor?: ColorPalette | undefined;
+    content: any[];
+    cardsGap?: SpacingLevel | undefined;
+}>, {
+    titleSize: string;
+    titleColor: string;
+    bgColor: string;
+    displayTagLine: boolean;
+    tagLineUpperCase: boolean;
+    tagLineSize: string;
+    tagLineColor: string;
+    displayHighlight: boolean;
+    highlightColor: string;
+    btnColor: string;
+    btnBgColor: string;
+    cardsGap: string;
+}>>> & {
+    "onBtn-prev"?: ((...args: any[]) => any) | undefined;
+    "onBtn-next"?: ((...args: any[]) => any) | undefined;
+}, {
+    titleColor: ColorPalette;
+    titleSize: HeadingSize;
+    bgColor: ColorPalette;
+    displayHighlight: boolean;
+    highlightColor: ColorPalette;
+    displayTagLine: boolean;
+    tagLineUpperCase: boolean;
+    tagLineSize: BodyText;
+    tagLineColor: ColorPalette;
+    btnColor: ColorPalette;
+    btnBgColor: ColorPalette;
+    cardsGap: SpacingLevel;
+}, {}>, {
+    description?(_: {}): any;
+    carousel?(_: {
+        cards: any[];
+        setRef: (el: any) => void;
+    }): 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,28 @@
+{
+  "name": "@bobbykim/mcl-carousel",
+  "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",
+    "@bobbykim/mcl-cards": "^0.2.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
+}
+}