@bobbykim/mcl-header 0.2.0

package/CHANGELOG.md

@@ -0,0 +1,14 @@
+# 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-container:** add mcl-container-b with story page ([95b522d](https://github.com/bobbykim89/manguito-component-library/commit/95b522d61a9a86422c5fbb8105a27a3957d453ac))
+* **mcl-header:** init mcl-header package and add mcl-header-a component ([29fe8d7](https://github.com/bobbykim89/manguito-component-library/commit/29fe8d7b62bed93d307f340e9a378f1dfe58a03a))
+* **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-header
+
+Add description
+
+## Demo
+
+[MCL Histoire Page](https://manguito-component-library.vercel.app/story/{%story-link%})
+
+## Install
+
+## Usage
+
+`import MclHeader from "@bobbykim/mcl-header"`;
+
+## 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 MclHeaderA from './lib/mcl-header-a/MclHeaderA.vue';
+export * from './lib/mcl-header-a/index.types';
+export { MclHeaderA };

package/index.js

@@ -0,0 +1,3 @@
+import MclHeaderA from './lib/mcl-header-a/MclHeaderA.vue';
+export * from './lib/mcl-header-a/index.types';
+export { MclHeaderA };

package/index.ts

@@ -0,0 +1,4 @@
+import MclHeaderA from './lib/mcl-header-a/MclHeaderA.vue'
+export * from './lib/mcl-header-a/index.types'
+
+export { MclHeaderA }

package/lib/common/HamburgerMenu.vue

@@ -0,0 +1,121 @@
+<script setup lang="ts">
+import { computed } from 'vue'
+import type { ColorPalette } from '@bobbykim/manguito-theme'
+import generateClass from '@bobbykim/manguito-theme'
+
+const props = withDefaults(
+  defineProps<{
+    color?: ColorPalette
+    displayBorder?: boolean
+    toggle: boolean
+    navColor: ColorPalette
+  }>(),
+  {
+    color: 'dark-2',
+    displayBorder: true,
+  }
+)
+
+const emit = defineEmits(['hbg-click'])
+
+const handleButtonToggle = (e: Event): void => {
+  emit('hbg-click', e)
+}
+
+const hamburgetButtonState = computed({
+  get() {
+    return props.toggle
+  },
+  set(value) {
+    return value
+  },
+})
+
+const getBorderClass = (
+  bColor: ColorPalette,
+  border: boolean,
+  nColor: ColorPalette
+): string => {
+  /**
+   * @bColor - color
+   * @border - displayBorder
+   * @nColor - navColor
+   */
+
+  const classArray: string[] = [
+    generateClass('RINGCOLOR', bColor),
+    generateClass('OFFSETRING', nColor),
+  ]
+
+  if (border) {
+    classArray.push(generateClass('BORDER', bColor))
+    classArray.push('border')
+  }
+  return classArray.join(' ')
+}
+
+const getHamburgerButtonClass = (color: ColorPalette): string => {
+  /**
+   * @color - color
+   */
+  const classArray: string[] = [
+    generateClass('BGCOLOR', color),
+    generateClass('BEFOREBG', color),
+    generateClass('AFTERBG', color),
+  ]
+
+  return classArray.join(' ')
+}
+</script>
+
+<template>
+  <button
+    class="p-3xs rounded-md aspect-square outline-none focus:ring-4 ring-offset-2 transition-all duration-300 ease-linear hover:opacity-70 focus:opacity-70 hamburger__button"
+    :class="getBorderClass(color, displayBorder, navColor)"
+    @click="handleButtonToggle"
+  >
+    <input
+      type="checkbox"
+      v-model="hamburgetButtonState"
+      class="hidden hamburger__checkbox"
+    />
+    <div
+      class="relative h-[3px] w-sm hamburger__icon before:w-sm after:w-sm before:h-[3px] after:h-[3px] transition-all duration-300 ease-linear"
+      :class="getHamburgerButtonClass(color)"
+    ></div>
+  </button>
+</template>
+
+<style lang="scss" scoped>
+.hamburger__icon {
+  &::before,
+  &::after {
+    position: absolute;
+    left: 0;
+    transition: all 0.3s linear;
+  }
+  &::before {
+    top: -0.5rem;
+  }
+  &::after {
+    top: 0.5rem;
+  }
+}
+.hamburger__button {
+  &:focus .hamburger__icon,
+  &:hover .hamburger__icon {
+    scale: 1.05;
+  }
+}
+.hamburger__checkbox:checked + .hamburger__icon {
+  background-color: transparent;
+}
+.hamburger__checkbox:checked + .hamburger__icon::before {
+  top: 0;
+  transform: rotate(135deg);
+}
+.hamburger__checkbox:checked + .hamburger__icon::after {
+  top: 0;
+  transform: rotate(-135deg);
+}
+</style>

package/lib/common/HamburgerMenu.vue.d.ts

@@ -0,0 +1,43 @@
+import type { ColorPalette } from '@bobbykim/manguito-theme';
+declare const _default: import("vue").DefineComponent<__VLS_WithDefaults<__VLS_TypePropsToRuntimeProps<{
+    color?: ColorPalette | undefined;
+    displayBorder?: boolean | undefined;
+    toggle: boolean;
+    navColor: ColorPalette;
+}>, {
+    color: string;
+    displayBorder: boolean;
+}>, {}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
+    "hbg-click": (...args: any[]) => void;
+}, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<__VLS_WithDefaults<__VLS_TypePropsToRuntimeProps<{
+    color?: ColorPalette | undefined;
+    displayBorder?: boolean | undefined;
+    toggle: boolean;
+    navColor: ColorPalette;
+}>, {
+    color: string;
+    displayBorder: boolean;
+}>>> & {
+    "onHbg-click"?: ((...args: any[]) => any) | undefined;
+}, {
+    color: ColorPalette;
+    displayBorder: boolean;
+}, {}>;
+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];
+} & {};

package/lib/mcl-header-a/MclHeaderA.vue

@@ -0,0 +1,382 @@
+<script setup lang="ts">
+import type {
+  BodyText,
+  ColorPalette,
+  CtaTarget,
+  HeadingSize,
+} from '@bobbykim/manguito-theme'
+import generateClass from '@bobbykim/manguito-theme'
+import { useWindowScroll } from '@vueuse/core'
+import { Transition, computed, ref, useSlots } from 'vue'
+import HamburgerMenu from '../common/HamburgerMenu.vue'
+import NavCollapse from './NavCollapse.vue'
+import NavDropdown from './NavDropdown.vue'
+import NavLink from './NavLink.vue'
+import type {
+  MenuCollapseType,
+  MenuEventType,
+  MenuItemType,
+  NavChildClickEventType,
+} from './index.types'
+
+const props = withDefaults(
+  defineProps<{
+    logo: string
+    logoSmall?: string
+    logoAlt?: string
+    logoAsLink?: boolean
+    logoLink: string
+    logoLinkTarget?: CtaTarget
+    title: string
+    titleSize?: HeadingSize
+    titleColor?: ColorPalette
+    titleAsLink?: boolean
+    titleLink: string
+    titleLinkTarget?: CtaTarget
+    menuItems: Array<MenuItemType | MenuCollapseType>
+    menuItemAsLink?: boolean
+    menuTextSize?: BodyText
+    menuTextColor?: ColorPalette
+    menuTextBold?: boolean
+    displayHighlight?: boolean
+    highlightColor?: ColorPalette
+    bgColor?: ColorPalette
+    mobileMenuBgColor?: ColorPalette
+    secondaryColor?: ColorPalette
+    hamburgerBorder?: boolean
+    fadeInOnScroll?: boolean
+    scrollDistance?: number
+  }>(),
+  {
+    logoAsLink: true,
+    logoLinkTarget: '_self',
+    titleSize: 'md',
+    titleColor: 'dark-3',
+    titleAsLink: true,
+    titleLinkTarget: '_self',
+    menuItemAsLink: true,
+    menuTextSize: 'md',
+    menuTextColor: 'dark-3',
+    menuTextBold: false,
+    displayHighlight: true,
+    highlightColor: 'primary',
+    bgColor: 'light-1',
+    mobileMenuBgColor: 'light-2',
+    secondaryColor: 'dark-1',
+    hamburgerBorder: true,
+    fadeInOnScroll: true,
+    scrollDistance: 50,
+  }
+)
+
+const navOpen = ref<boolean>(false)
+const slots = useSlots()
+const emit = defineEmits([
+  'toggle-menu',
+  'menu-click',
+  'title-click',
+  'logo-click',
+])
+const { y } = useWindowScroll()
+
+type EmitType = 'menu' | 'title' | 'logo'
+
+const closeNav = (): void => {
+  navOpen.value = false
+}
+
+const toggleNavButton = (e: Event): void => {
+  navOpen.value = !navOpen.value
+  emit('toggle-menu', e)
+}
+
+const navItemClick = (
+  e: Event,
+  title: string,
+  link: string,
+  target: CtaTarget = '_self',
+  itemLink: boolean,
+  emitType: EmitType
+): void => {
+  /**
+   * @param {Event} e - $event
+   * @param {string} link - menuItems[#].url / titleLink
+   * @param {CtaTarget} target - menuItems[#].target / titleLinkTaget
+   * @param {boolean} itemlink - menuItemAsLink /
+   * @param {EmitType} emitType - Non prop value type EmitType
+   */
+  navOpen.value = false
+  const menuEvent: MenuEventType = {
+    event: e,
+    title: title,
+    link: link,
+    target: target ? target : '_self',
+  }
+  if (!itemLink) {
+    e.preventDefault()
+  }
+  if (emitType === 'menu') {
+    emit('menu-click', menuEvent)
+  }
+  if (emitType === 'title') {
+    emit('title-click', menuEvent)
+  }
+  if (emitType === 'logo') {
+    emit('logo-click', menuEvent)
+  }
+}
+const navChildLinkClick = (e: NavChildClickEventType): void => {
+  /**
+   * @param {NavChildClickEventType} e - Event emitted from dropdown/collapse click events
+   */
+  const { title, url, target } = e.item
+  navOpen.value = false
+  const menuEvent: MenuEventType = {
+    event: e.event,
+    title,
+    link: url,
+    target: target ? target : '_self',
+  }
+  emit('menu-click', menuEvent)
+}
+
+const getTitleClass = (size: HeadingSize, color: ColorPalette): string => {
+  /**
+   * @param {HeadingSize} size - titleSize
+   * @param {ColorPalette} color - titleColor
+   */
+  const classArray: string[] = [
+    generateClass('H2', size),
+    generateClass('TEXTCOLOR', color),
+  ]
+  return classArray.join(' ')
+}
+
+/**
+ * @TransitionFunctions
+ * @param {HTMLElement} el - passed any since transition handlers don't accept HTMLElement (accepts Element)
+ */
+const onEnter = (el: any) => {
+  el.style.height = 'auto'
+  const endWidth = getComputedStyle(el).height
+  el.style.height = '0px'
+  el.offsetHeight // force repaint
+  el.style.height = endWidth
+}
+const onAfterEnter = (el: any) => {
+  el.style.height = 'auto'
+}
+const onLeave = (el: any) => {
+  el.style.height = getComputedStyle(el).height
+  el.offsetHeight // force repaint
+  el.style.height = '0px'
+}
+
+const hasChildren = (item: MenuItemType | MenuCollapseType) => {
+  const NavCollapse = item as MenuCollapseType
+  if (typeof NavCollapse.children === 'undefined') {
+    return false
+  }
+  return NavCollapse.children.length > 0
+}
+
+const handleFadeInOnScroll = computed(() => {
+  const { fadeInOnScroll, scrollDistance } = props
+  if (!fadeInOnScroll) {
+    return ''
+  }
+  return y.value >= scrollDistance
+    ? 'lg:shadow-md bg-opacity-70'
+    : 'bg-opacity-100'
+})
+</script>
+
+<template>
+  <header
+    class="w-full top-0 md:sticky items-center z-50 transition ease-in duration-500 delay-150"
+    :class="[handleFadeInOnScroll, generateClass('BGCOLOR', bgColor)]"
+  >
+    <nav
+      class="flex flex-wrap items-center py-xs md:py-2xs mx-xs md:mx-sm align-middle justify-between sm:max-w-[640px] md:max-w-[768px] lg:max-w-[1024px] xl:max-w-[1280px] 2xl:max-w-[1536px]"
+    >
+      <div class="flex flex-shrink-0 items-center self-center">
+        <div class="h-md md:h-lg lg:h-xl mr-2xs md:mr-sm align-middle">
+          <a
+            :href="logoLink"
+            :target="logoLinkTarget"
+            @click="
+              navItemClick(
+                $event,
+                title,
+                logoLink,
+                logoLinkTarget,
+                logoAsLink,
+                'logo'
+              )
+            "
+          >
+            <img
+              :src="logo"
+              :alt="logoAlt"
+              class="h-full"
+              :class="[logoSmall ? 'hidden lg:inline-block' : 'inline-block']"
+            />
+            <img
+              v-if="logoSmall"
+              :src="logoSmall"
+              :alt="logoAlt"
+              class="inline-block lg:hidden h-full"
+            />
+          </a>
+        </div>
+        <div class="flex flex-col justify-center ml-2">
+          <a
+            :href="titleLink"
+            :target="titleLinkTarget"
+            @click="
+              navItemClick(
+                $event,
+                title,
+                titleLink,
+                titleLinkTarget,
+                titleAsLink,
+                'title'
+              )
+            "
+          >
+            <h2
+              class="inline-block align-middle tracking-wider"
+              :class="getTitleClass(titleSize, titleColor)"
+              v-html="title"
+            ></h2>
+          </a>
+          <!-- desktop nav menu -->
+          <ul class="hidden lg:flex flex-wrap">
+            <li
+              class="mr-xs last:mr-0"
+              v-for="(item, index) in menuItems"
+              :key="`menu-${index}`"
+            >
+              <nav-link
+                v-if="!hasChildren(item)"
+                :nav-item="(item as MenuItemType)"
+                :menu-text-color="menuTextColor"
+                :menu-text-size="menuTextSize"
+                :menu-text-bold="menuTextBold"
+                :display-highlight="displayHighlight"
+                :highlight-color="highlightColor"
+                :as-link="menuItemAsLink"
+                @nav-link="
+                  navItemClick(
+                    $event,
+                    item.title,
+                    (item as MenuItemType).url,
+                    (item as MenuItemType).target,
+                    menuItemAsLink,
+                    'menu'
+                  )
+                "
+              ></nav-link>
+              <nav-dropdown
+                v-else
+                :nav-item="(item as MenuCollapseType)"
+                :menu-text-color="menuTextColor"
+                :menu-text-size="menuTextSize"
+                :menu-text-bold="menuTextBold"
+                :display-highlight="displayHighlight"
+                :highlight-color="highlightColor"
+                :bg-color="bgColor"
+                :hover-bg-color="secondaryColor"
+                :as-link="menuItemAsLink"
+                @nav-link="navChildLinkClick"
+              ></nav-dropdown>
+            </li>
+          </ul>
+        </div>
+      </div>
+      <div>
+        <hamburger-menu
+          :color="secondaryColor"
+          :display-border="hamburgerBorder"
+          class="block lg:hidden"
+          @hbg-click="toggleNavButton"
+          :toggle="navOpen"
+          :nav-color="bgColor"
+        ></hamburger-menu>
+        <div v-if="slots['nav-slot']" class="hidden lg:block">
+          <slot name="nav-slot"></slot>
+        </div>
+      </div>
+    </nav>
+    <!-- mobile menu -->
+
+    <div class="overflow-hidden lg:hidden">
+      <transition
+        name="collapse"
+        @enter="onEnter"
+        @after-enter="onAfterEnter"
+        @leave="onLeave"
+      >
+        <div
+          class="bg-opacity-80 rounded-md my-2xs mx-xs overflow-hidden"
+          v-if="navOpen"
+          :class="generateClass('BGCOLOR', mobileMenuBgColor)"
+        >
+          <ul class="flex flex-col items-center justify-center p-xs">
+            <li
+              class="mb-2xs last:mb-0"
+              v-for="(item, index) in menuItems"
+              :key="`mobile-${index}`"
+            >
+              <nav-link
+                v-if="!hasChildren(item)"
+                :nav-item="(item as MenuItemType)"
+                :menu-text-color="menuTextColor"
+                :menu-text-size="menuTextSize"
+                :menu-text-bold="menuTextBold"
+                :display-highlight="displayHighlight"
+                :highlight-color="highlightColor"
+                :as-link="menuItemAsLink"
+                @nav-link="
+                  navItemClick(
+                    $event,
+                    item.title,
+                    (item as MenuItemType).url,
+                    (item as MenuItemType).target,
+                    menuItemAsLink,
+                    'menu'
+                  )
+                "
+              ></nav-link>
+              <nav-collapse
+                v-else
+                :nav-id="item.title"
+                :nav-item="(item as MenuCollapseType)"
+                :menu-text-color="menuTextColor"
+                :menu-text-size="menuTextSize"
+                :menu-text-bold="menuTextBold"
+                :display-highlight="displayHighlight"
+                :highlight-color="highlightColor"
+                :nav-accordion-group="title"
+                :as-link="menuItemAsLink"
+                @nav-link="navChildLinkClick"
+              ></nav-collapse>
+            </li>
+          </ul>
+          <div v-if="slots['mobile-slot']">
+            <slot name="mobile-slot" :close-nav="closeNav"></slot>
+          </div>
+        </div>
+      </transition>
+    </div>
+  </header>
+</template>
+
+<style lang="scss" scoped>
+.collapse-enter-active {
+  transition: height 0.5s ease-in;
+}
+.collapse-leave-active {
+  transition: height 0.5s ease-out;
+}
+</style>