@ulu/frontend-vue 0.1.0-beta.5 → 0.1.0-beta.6

package/lib/components/collapsible/UluAccordion.vue

@@ -23,7 +23,7 @@
         <slot name="icon" :open="open">
           <span class="accordion__icon" :class="classes.icon">
             <UluIcon 
-              :type="open ? 'collapse' : 'expand'"
+              :icon="open ? 'type:collapse' : 'type:expand'"
               style="display: inline;"
             />
           </span>

package/lib/components/collapsible/UluModal.vue

@@ -26,7 +26,7 @@
             <UluIcon 
               v-if="titleIcon" 
               class="modal__title-icon" 
-              :definition="titleIcon" 
+              :icon="titleIcon" 
             />
             <span class="modal__title-text">{{ title }}</span>
           </slot>
@@ -35,8 +35,7 @@
           <slot name="closeIcon">
             <UluIcon 
               class="modal__close-icon" 
-              type="close" 
-              :definition="closeIcon" 
+              :icon="closeIcon || 'type:close'" 
             />
           </slot>
         </button>
@@ -56,7 +55,7 @@
       </div>
       <button v-if="resizerEnabled" class="modal__resizer" ref="resizer" type="button">
         <slot name="resizerIcon">
-          <UluIcon class="modal__resizer-icon" :type="resizerIconType" :definition="resizerIcon" />
+          <UluIcon class="modal__resizer-icon" :icon="resizerIcon || resizerIconType" />
         </slot>
       </button>
     </dialog>
@@ -213,7 +212,7 @@
       });
 
       const resizerIconType = computed(() => {
-        return props.position === 'center' ? 'resizeBoth' : 'resizeHorizontal';
+        return props.position === 'center' ? 'type:resizeBoth' : 'type:resizeHorizontal';
       });
 
       // Define the internal modifiers object as a computed property (so it can react to changes)

package/lib/components/collapsible/UluOverflowPopover.vue

@@ -9,7 +9,7 @@
       size="large"
     >
       <template #trigger>
-        <UluIcon type="ellipsis" :definition="triggerIcon"/>
+        <UluIcon :icon="triggerIcon || 'type:ellipsis'"/>
       </template>
       <template #content>
         <div class="type-word-break">

package/lib/components/elements/UluAlert.vue

@@ -4,8 +4,7 @@
       <UluIcon 
         class="type-large margin-right-small" 
         :class="`color-${ type }`"
-        :type="type"
-        :definition="icon"
+        :icon="icon || `type:${type}`"
       />
       <div class="type-small">
         <div>

package/lib/components/elements/UluButton.vue

@@ -22,7 +22,7 @@
     <slot name="before"/>
     <UluIcon 
       v-if="icon && (iconBefore || iconOnly)"
-      :definition="icon"
+      :icon="icon"
       class="button__icon"
     />
     <span v-if="($slots.default || text) && !iconOnly">
@@ -32,7 +32,7 @@
     </span>
     <UluIcon 
       v-if="icon && (!iconBefore && !iconOnly)"
-      :definition="icon"
+      :icon="icon"
       class="button__icon"
     />
     <slot name="after"/>

package/lib/components/elements/UluExternalLink.vue

@@ -5,8 +5,7 @@
     </span>
     <UluIcon 
       class="external-link__icon margin-left-small-x display-inline"
-      type="externalLink"
-      :definition="icon"
+      :icon="icon || 'type:externalLink'"
     />
   </a>
 </template>

package/lib/components/elements/UluIcon.vue

@@ -27,15 +27,11 @@
   let FaModule;
 
   const props = defineProps({
-    /**
-     * Semantic type of icon to use, will be resolved from settings
-     */
-    type: String,
     /**
      * Icon definition can be string (fa classes), or array or object (any prop format FaIcon accepts)
      * - This will override the 'type' prop if both are provided
      */
-    definition: [String, Array, Object, Boolean],
+    icon: [String, Array, Object, Boolean],
   });
 
   const useStaticFa = computed(() => {
@@ -52,18 +48,17 @@
 
   // Resolve the final icon definition, giving precedence to the `definition` prop
   const resolvedDefinition = computed(() => {
-    if (props.definition) {
-      return props.definition;
-    }
-    if (props.type) {
+    const { icon } = props;
+    if (typeof icon === 'string' && icon.startsWith('type:')) {
       try {
-        return uluCore.getIcon(props.type);
+        const type = icon.substring(5);
+        return uluCore.getIcon(type);
       } catch (e) {
         console.warn(e);
         return null;
       }
     }
-    return null;
+    return icon;
   });
 
   const customIconProps = computed(() => {

package/lib/components/elements/UluTag.vue

@@ -10,7 +10,7 @@
       resolvedModifiers
     ]"
   >
-    <UluIcon v-if="icon" :definition="icon" />
+    <UluIcon v-if="icon" :icon="icon" />
     <slot>
       {{ text }}
     </slot>

package/lib/components/layout/UluTitleRail.vue

@@ -8,10 +8,9 @@
         :style="{ alignItems: iconAlign }"
       >
         <UluIcon 
-          v-if="icon || iconType" 
+          v-if="icon"
           :class="classes.icon"
-          :type="iconType" 
-          :definition="icon"
+          :icon="icon"
         />
         <slot>
           {{ title }}
@@ -38,7 +37,6 @@
         type: String,
         default: "baseline"
       },
-      iconType: String,
       classes: {
         type: Object,
         default: () => ({

package/lib/components/navigation/UluBreadcrumb.vue

@@ -19,8 +19,7 @@
           <slot name="separator">
             <UluIcon
               :class="classes.separator"
-              type="pathSeparator"
-              :definition="separatorIcon"
+              :icon="separatorIcon || 'type:pathSeparator'"
             />
           </slot>
         </template>

package/lib/components/navigation/UluMenu.vue

@@ -26,7 +26,7 @@
         <slot :item="item" :index="index">
           <UluIcon 
             v-if="item.icon" 
-            :definition="item.icon" 
+            :icon="item.icon" 
             :class="[classes.linkIcon, item?.classes?.linkIcon]"
           />
           <span :class="[classes.linkText, item?.classes?.linkText]">{{ item.title }}</span>

package/lib/plugins/core/index.js

@@ -8,7 +8,7 @@ const defaults = {
   fontAwesomeStatic: false,
   iconComponent: null,
   iconPropResolver: (definition) => ({ icon: definition }),
-  icons: {
+  iconsByType: {
     danger: "fas fa-triangle-exclamation",
     warning: "fas fa-circle-exclamation",
     info: "fas fa-circle-info",
@@ -25,14 +25,14 @@ const defaults = {
   }
 };
 
-export const iconKeys = Object.keys(defaults.icons);
+export const iconKeys = Object.keys(defaults.iconsByType);
 
 export default function install(app, userSettings = {}) {
   // A single reactive object for all settings
   const settings = reactive({ ...defaults });
 
   // Separate icon overrides from other options to handle them safely
-  const { icons: iconOverrides, ...otherOptions } = userSettings || {};
+  const { iconsByType: iconOverrides, ...otherOptions } = userSettings || {};
 
   // Merge any user-provided options during installation
   if (otherOptions) {
@@ -64,14 +64,14 @@ export default function install(app, userSettings = {}) {
       settings[key] = value;
     },
     getIcon(type) {
-      const icons = settings.icons;
+      const icons = settings.iconsByType;
       if (!icons[type]) {
         throw new Error(`Icon type "${type}" not found!`);
       }
       return icons[type];
     },
     setIcon(type, definition) {
-      settings.icons[type] = definition;
+      settings.iconsByType[type] = definition;
     }
   };
 

package/lib/plugins/toast/UluToast.vue

@@ -43,7 +43,7 @@
       </button>
     </div>
     <button class="toast__close" :class="classes.closeButton" @click="toast.close">
-      <UluIcon type="close"/>
+      <UluIcon :icon="'type:close'"/>
     </button>
   </div>
 </template>

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ulu/frontend-vue",
-  "version": "0.1.0-beta.5",
+  "version": "0.1.0-beta.6",
   "description": "A modular and tree-shakeable Vue 3 component library for the Ulu frontend",
   "type": "module",
   "files": [
@@ -18,15 +18,23 @@
     "./*": "./lib/*",
     "./scss": "./lib/_index.scss"
   },
+  "typesVersions": {
+    "*": {
+      "lib/*": [
+        "./types/*"
+      ]
+    }
+  },
   "repository": {
     "type": "git",
     "url": "git+https://github.com/Jscherbe/frontend-vue.git"
   },
   "scripts": {
     "dev": "storybook dev -p 6006",
-    "docs:build": "storybook build -o docs --docs",
+    "docs:build": "storybook build -o docs",
     "build": "vite build",
-    "deploy": "npm run build && npm run docs:build"
+    "types": "npx tsc",
+    "deploy": "npm run types && npm run build && npm run docs:build"
   },
   "keywords": [
     "vue",
@@ -78,7 +86,8 @@
     "storybook": "^9.1.1",
     "storybook-addon-vue-mdx": "^2.0.2",
     "vite": "^7.0.0",
-    "vue-router": "^4.5.1"
+    "vue-router": "^4.5.1",
+    "typescript": "^5.3.3"
   },
   "volta": {
     "node": "22.17.0"