@bobbykim/manguito-theme 0.1.1 → 0.1.3

package/LICENSE.md

@@ -1,9 +1,9 @@
-MIT License
-
-Copyright (c) 2022-present 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.
+MIT License
+
+Copyright (c) 2022-present 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,60 @@
+# @bobbykim/manguito-theme
+
+manguito-theme includes basic config for MCL, including theme.types and generateClass function that returns tailwindCSS style classes.
+
+## Demo
+
+[MCL Histoire Page](https://manguito-component-library.vercel.app/story/src-stories-documentation-mcltheme-story-vue?variantId=src-stories-documentation-mcltheme-story-vue-0)
+
+## Install
+
+```sh
+npm i -D tailwindcss postcss autoprefixer sass
+npm i @bobbykim/manguito-theme
+npx tailwindcss init -p
+```
+
+## Setup
+
+tailwind.config.cjs
+
+```cjs
+const {
+  mclTheme,
+  mclHeading,
+} = require('@bobbykim/manguito-theme/themeVariables.cjs')
+
+module.exports = {
+  content: [
+    './src/**/*.{vue,ts,js,cjs}',
+    './node_modules/@bobbykim/**/*.{vue,ts,js,cjs}',
+  ],
+  theme: mclTheme,
+  plugins: [mclHeading],
+}
+```
+
+## Usage
+
+`import generateClass from '@bobbykim/manguito-theme'`
+
+in Vue component file.
+
+```vue
+<script setup lang="ts">
+...
+import generateClass from '@bobbykim/manguito-theme'
+import type { <Type you need> } from '@bobbykim/manguito-theme/theme/theme.types'
+...
+</script>
+
+<template>...</template>
+```
+
+## Authors
+
+- **Bobby Kim** - _Initial work_
+
+## License
+
+This project is licensed under the MIT License - see the [LICENSE.md](./LICENSE.md) file for details

package/index.ts

@@ -1,10 +1,10 @@
-import GenerateMCLClass from './theme/generateClass'
-import type { ClassType, InputType } from './theme/generateClass'
-
-const generateClass = (type: ClassType, value: InputType): string => {
-  const mclGenerate = new GenerateMCLClass(type, value)
-
-  return mclGenerate.generateClassName()
-}
-
-export default generateClass
+import GenerateMCLClass from './theme/generateClass'
+import type { ClassType, InputType } from './theme/generateClass'
+
+const generateClass = (type: ClassType, value: InputType): string => {
+  const mclGenerate = new GenerateMCLClass(type, value)
+
+  return mclGenerate.generateClassName()
+}
+
+export default generateClass

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bobbykim/manguito-theme",
-  "version": "0.1.1",
+  "version": "0.1.3",
   "description": "main theme file for manguito components library. Other MCL components will need to import this file to run.",
   "type": "module",
   "main": "index.ts",
@@ -11,10 +11,11 @@
     "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"
   },
   "license": "MIT",
-  "gitHead": "5189401f3c156def59f6c56cb94486943419d06c"
+  "gitHead": "4e6b9b908a17893f6e6baab01741dc0dde771ac8"
 }

package/theme/generateClass.ts

@@ -1,231 +1,234 @@
-import MCLTheme from './theme'
-import type {
-  ColorPalette,
-  HeadingSize,
-  BodyText,
-  FontWeight,
-  Range,
-  OpacityRange,
-  SpacingLevel,
-} from './theme.types'
-
-/**
- * @TailwindCSS - Good practice is to let all of used classes to be in full instead of generated dynamically using methods such as string literal.
- * @Interface - ClassType to define the case, and Input type to generate tailwind clssname.
- * @Export GenerateRDSClass - extends RDSTheme class
- */
-
-export type ClassType =
-  | 'BGCOLOR'
-  | 'BEFOREBG'
-  | 'AFTERBG'
-  | 'TEXTCOLOR'
-  | 'DISABLEDTEXTCOLOR'
-  | 'SVGFILL'
-  | 'RINGCOLOR'
-  | 'FOCUSRING'
-  | 'ACTIVERING'
-  | 'ACTIVEBG'
-  | 'H1'
-  | 'H2'
-  | 'H3'
-  | 'H4'
-  | 'BODYTEXT'
-  | 'FONTWEIGHT'
-  | 'BORDER'
-  | 'BORDERX'
-  | 'BORDERY'
-  | 'BORDERT'
-  | 'BORDERL'
-  | 'BORDERB'
-  | 'BORDERTW'
-  | 'BORDERLW'
-  | 'HVBGCOLOR'
-  | 'HVTEXTCOLOR'
-  | 'BGOPACITY'
-  | 'OPACITY'
-  | 'MARGINB'
-
-export type InputType =
-  | ColorPalette
-  | HeadingSize
-  | BodyText
-  | FontWeight
-  | Range<12>
-  | OpacityRange
-  | SpacingLevel
-
-class GenerateMCLClass extends MCLTheme {
-  classType: ClassType
-  classValue: InputType
-
-  constructor(classType: ClassType, classValue: InputType) {
-    super()
-    this.classType = classType
-    this.classValue = classValue
-  }
-  generateClassName(): string {
-    switch (this.classType) {
-      case 'BGCOLOR':
-      case 'BEFOREBG':
-      case 'AFTERBG':
-      case 'TEXTCOLOR':
-      case 'DISABLEDTEXTCOLOR':
-      case 'SVGFILL':
-      case 'RINGCOLOR':
-      case 'FOCUSRING':
-      case 'ACTIVERING':
-      case 'ACTIVEBG':
-        return this.getColorClass()
-      case 'HVBGCOLOR':
-      case 'HVTEXTCOLOR':
-        return this.getHoverColorClass()
-      case 'H1':
-      case 'H2':
-      case 'H3':
-      case 'H4':
-        return this.getHeadingTextSizeClass()
-      case 'BODYTEXT':
-        return this.getBodyTextSizeClass()
-      case 'FONTWEIGHT':
-        return this.getFontWeightClass()
-      case 'BORDER':
-      case 'BORDERX':
-      case 'BORDERY':
-      case 'BORDERT':
-      case 'BORDERB':
-      case 'BORDERL':
-        return this.getBorderColorClass()
-      case 'BORDERTW':
-      case 'BORDERLW':
-        return this.getBorderWidthClass()
-      case 'BGOPACITY':
-        return this.getBgOpacityClass()
-      case 'OPACITY':
-        return this.getOpacityClass()
-      case 'MARGINB':
-        return this.getSpacingClass()
-      default:
-        return
-    }
-  }
-  getColorClass(): string {
-    const {
-      bgColor,
-      beforeBgColor,
-      afterBgColor,
-      textColor,
-      disabledTextColor,
-      svgFillColor,
-      ringColor,
-      ringFocusColor,
-      ringActiveColor,
-      bgActiveColor,
-    } = MCLTheme
-    if (this.classType === 'BGCOLOR') {
-      return bgColor[this.classValue]
-    }
-    if (this.classType === 'BEFOREBG') {
-      return beforeBgColor[this.classValue]
-    }
-    if (this.classType === 'AFTERBG') {
-      return afterBgColor[this.classValue]
-    }
-    if (this.classType === 'TEXTCOLOR') {
-      return textColor[this.classValue]
-    }
-    if (this.classType === 'DISABLEDTEXTCOLOR') {
-      return disabledTextColor[this.classValue]
-    }
-    if (this.classType === 'SVGFILL') {
-      return svgFillColor[this.classValue]
-    }
-    if (this.classType === 'FOCUSRING') {
-      return ringFocusColor[this.classValue]
-    }
-    if (this.classType === 'ACTIVERING') {
-      return ringActiveColor[this.classValue]
-    }
-    if (this.classType === 'ACTIVEBG') {
-      return bgActiveColor[this.classValue]
-    }
-    return ringColor[this.classValue]
-  }
-  getHoverColorClass(): string {
-    const { hoverBgColor, hoverTextColor } = MCLTheme
-    if (this.classType === 'HVBGCOLOR') {
-      return hoverBgColor[this.classValue]
-    }
-    return hoverTextColor[this.classValue]
-  }
-  getHeadingTextSizeClass(): string {
-    const { heading1, heading2, heading3, heading4 } = MCLTheme
-    if (this.classType === 'H1') {
-      return heading1[this.classValue]
-    }
-    if (this.classType === 'H2') {
-      return heading2[this.classValue]
-    }
-    if (this.classType === 'H3') {
-      return heading3[this.classValue]
-    }
-    return heading4[this.classValue]
-  }
-  getBodyTextSizeClass(): string {
-    const { bodyText } = MCLTheme
-    return bodyText[this.classValue]
-  }
-  getFontWeightClass(): string {
-    const { fontweight } = MCLTheme
-    return fontweight[this.classValue]
-  }
-  getBorderColorClass(): string {
-    const {
-      borderColor,
-      borderXColor,
-      borderYColor,
-      borderTopColor,
-      borderBottomColor,
-      borderLeftColor,
-    } = MCLTheme
-    if (this.classType === 'BORDERX') {
-      return borderXColor[this.classValue]
-    }
-    if (this.classType === 'BORDERY') {
-      return borderYColor[this.classValue]
-    }
-    if (this.classType === 'BORDERT') {
-      return borderTopColor[this.classValue]
-    }
-    if (this.classType === 'BORDERB') {
-      return borderBottomColor[this.classValue]
-    }
-    if (this.classType === 'BORDERL') {
-      return borderLeftColor[this.classValue]
-    }
-    return borderColor[this.classValue]
-  }
-  getBorderWidthClass(): string {
-    const { borderTopWidth, borderLeftWidth } = MCLTheme
-    if (this.classType === 'BORDERTW') {
-      return borderTopWidth[this.classValue]
-    }
-    return borderLeftWidth[this.classValue]
-  }
-  getBgOpacityClass(): string {
-    const { backgroundOpacity } = MCLTheme
-    return backgroundOpacity[this.classValue]
-  }
-  getOpacityClass(): string {
-    const { opacity } = MCLTheme
-    return opacity[this.classValue]
-  }
-  getSpacingClass(): string {
-    const { marginBottom } = MCLTheme
-    if (this.classType === 'MARGINB') {
-      return marginBottom[this.classValue]
-    }
-  }
-}
-
-export default GenerateMCLClass
+import MCLTheme from './theme'
+import type {
+  ColorPalette,
+  HeadingSize,
+  BodyText,
+  FontWeight,
+  Range,
+  OpacityRange,
+  SpacingLevel,
+} from './theme.types'
+
+/**
+ * @TailwindCSS - Good practice is to let all of used classes to be in full instead of generated dynamically using methods such as string literal.
+ * @Interface - ClassType to define the case, and Input type to generate tailwind clssname.
+ * @Export GenerateRDSClass - extends RDSTheme class
+ */
+
+export type ClassType =
+  | 'BGCOLOR'
+  | 'BEFOREBG'
+  | 'AFTERBG'
+  | 'TEXTCOLOR'
+  | 'DISABLEDTEXTCOLOR'
+  | 'SVGFILL'
+  | 'RINGCOLOR'
+  | 'FOCUSRING'
+  | 'ACTIVERING'
+  | 'ACTIVEBG'
+  | 'H1'
+  | 'H2'
+  | 'H3'
+  | 'H4'
+  | 'BODYTEXT'
+  | 'FONTWEIGHT'
+  | 'BORDER'
+  | 'BORDERX'
+  | 'BORDERY'
+  | 'BORDERT'
+  | 'BORDERL'
+  | 'BORDERB'
+  | 'BORDERTW'
+  | 'BORDERLW'
+  | 'HVBGCOLOR'
+  | 'HVTEXTCOLOR'
+  | 'BGOPACITY'
+  | 'OPACITY'
+  | 'MARGINB'
+  | 'GAP'
+
+export type InputType =
+  | ColorPalette
+  | HeadingSize
+  | BodyText
+  | FontWeight
+  | Range<12>
+  | OpacityRange
+  | SpacingLevel
+
+class GenerateMCLClass extends MCLTheme {
+  classType: ClassType
+  classValue: InputType
+
+  constructor(classType: ClassType, classValue: InputType) {
+    super()
+    this.classType = classType
+    this.classValue = classValue
+  }
+  generateClassName(): string {
+    switch (this.classType) {
+      case 'BGCOLOR':
+      case 'BEFOREBG':
+      case 'AFTERBG':
+      case 'TEXTCOLOR':
+      case 'DISABLEDTEXTCOLOR':
+      case 'SVGFILL':
+      case 'RINGCOLOR':
+      case 'FOCUSRING':
+      case 'ACTIVERING':
+      case 'ACTIVEBG':
+        return this.getColorClass()
+      case 'HVBGCOLOR':
+      case 'HVTEXTCOLOR':
+        return this.getHoverColorClass()
+      case 'H1':
+      case 'H2':
+      case 'H3':
+      case 'H4':
+        return this.getHeadingTextSizeClass()
+      case 'BODYTEXT':
+        return this.getBodyTextSizeClass()
+      case 'FONTWEIGHT':
+        return this.getFontWeightClass()
+      case 'BORDER':
+      case 'BORDERX':
+      case 'BORDERY':
+      case 'BORDERT':
+      case 'BORDERB':
+      case 'BORDERL':
+        return this.getBorderColorClass()
+      case 'BORDERTW':
+      case 'BORDERLW':
+        return this.getBorderWidthClass()
+      case 'BGOPACITY':
+        return this.getBgOpacityClass()
+      case 'OPACITY':
+        return this.getOpacityClass()
+      case 'MARGINB':
+      case 'GAP':
+        return this.getSpacingClass()
+      default:
+        return
+    }
+  }
+  getColorClass(): string {
+    const {
+      bgColor,
+      beforeBgColor,
+      afterBgColor,
+      textColor,
+      disabledTextColor,
+      svgFillColor,
+      ringColor,
+      ringFocusColor,
+      ringActiveColor,
+      bgActiveColor,
+    } = MCLTheme
+    if (this.classType === 'BGCOLOR') {
+      return bgColor[this.classValue]
+    }
+    if (this.classType === 'BEFOREBG') {
+      return beforeBgColor[this.classValue]
+    }
+    if (this.classType === 'AFTERBG') {
+      return afterBgColor[this.classValue]
+    }
+    if (this.classType === 'TEXTCOLOR') {
+      return textColor[this.classValue]
+    }
+    if (this.classType === 'DISABLEDTEXTCOLOR') {
+      return disabledTextColor[this.classValue]
+    }
+    if (this.classType === 'SVGFILL') {
+      return svgFillColor[this.classValue]
+    }
+    if (this.classType === 'FOCUSRING') {
+      return ringFocusColor[this.classValue]
+    }
+    if (this.classType === 'ACTIVERING') {
+      return ringActiveColor[this.classValue]
+    }
+    if (this.classType === 'ACTIVEBG') {
+      return bgActiveColor[this.classValue]
+    }
+    return ringColor[this.classValue]
+  }
+  getHoverColorClass(): string {
+    const { hoverBgColor, hoverTextColor } = MCLTheme
+    if (this.classType === 'HVBGCOLOR') {
+      return hoverBgColor[this.classValue]
+    }
+    return hoverTextColor[this.classValue]
+  }
+  getHeadingTextSizeClass(): string {
+    const { heading1, heading2, heading3, heading4 } = MCLTheme
+    if (this.classType === 'H1') {
+      return heading1[this.classValue]
+    }
+    if (this.classType === 'H2') {
+      return heading2[this.classValue]
+    }
+    if (this.classType === 'H3') {
+      return heading3[this.classValue]
+    }
+    return heading4[this.classValue]
+  }
+  getBodyTextSizeClass(): string {
+    const { bodyText } = MCLTheme
+    return bodyText[this.classValue]
+  }
+  getFontWeightClass(): string {
+    const { fontweight } = MCLTheme
+    return fontweight[this.classValue]
+  }
+  getBorderColorClass(): string {
+    const {
+      borderColor,
+      borderXColor,
+      borderYColor,
+      borderTopColor,
+      borderBottomColor,
+      borderLeftColor,
+    } = MCLTheme
+    if (this.classType === 'BORDERX') {
+      return borderXColor[this.classValue]
+    }
+    if (this.classType === 'BORDERY') {
+      return borderYColor[this.classValue]
+    }
+    if (this.classType === 'BORDERT') {
+      return borderTopColor[this.classValue]
+    }
+    if (this.classType === 'BORDERB') {
+      return borderBottomColor[this.classValue]
+    }
+    if (this.classType === 'BORDERL') {
+      return borderLeftColor[this.classValue]
+    }
+    return borderColor[this.classValue]
+  }
+  getBorderWidthClass(): string {
+    const { borderTopWidth, borderLeftWidth } = MCLTheme
+    if (this.classType === 'BORDERTW') {
+      return borderTopWidth[this.classValue]
+    }
+    return borderLeftWidth[this.classValue]
+  }
+  getBgOpacityClass(): string {
+    const { backgroundOpacity } = MCLTheme
+    return backgroundOpacity[this.classValue]
+  }
+  getOpacityClass(): string {
+    const { opacity } = MCLTheme
+    return opacity[this.classValue]
+  }
+  getSpacingClass(): string {
+    const { marginBottom, gap } = MCLTheme
+    if (this.classType === 'MARGINB') {
+      return marginBottom[this.classValue]
+    }
+    return gap[this.classValue]
+  }
+}
+
+export default GenerateMCLClass