@ulu/frontend-vue 0.1.0-beta.3 → 0.1.0-beta.30

package/lib/components/systems/facets/UluFacetsResults.vue

@@ -0,0 +1,63 @@
+<template>
+  <div class="UluFacetsResults">
+    <transition-group
+      v-if="items.length"
+      :tag="tag"
+      :name="transitionName"
+      class="UluFacetsResults__list"
+      :class="classes.list"
+    >
+      <li
+        class="UluFacetsResults__item"
+        :class="classes.item"
+        v-for="(item, index) in items"
+        :key="item.id || index"
+      >
+        <slot name="item" :item="item" :index="index"></slot>
+      </li>
+    </transition-group>
+    <div v-else class="UluFacetsResults__empty">
+      <slot name="empty">
+        <p>No matching items found.</p>
+      </slot>
+    </div>
+  </div>
+</template>
+
+<script setup>
+  defineProps({
+    items: {
+      type: Array,
+      required: true
+    },
+    tag: {
+      type: String,
+      default: 'ul'
+    },
+    transitionName: {
+      type: String,
+      default: 'UluFacetsFade'
+    },
+    classes: {
+      type: Object,
+      default: () => ({})
+    }
+  });
+</script>
+
+<style lang="scss">
+  .UluFacetsResults__list {
+    list-style: none;
+    padding: 0;
+  }
+
+  .UluFacetsFade-enter-active,
+  .UluFacetsFade-leave-active {
+    transition: opacity 0.25s ease;
+  }
+
+  .UluFacetsFade-enter-from,
+  .UluFacetsFade-leave-to {
+    opacity: 0;
+  }
+</style>

package/lib/components/systems/facets/UluFacetsSearch.vue

@@ -10,58 +10,35 @@
       type="text" 
       :placeholder="placeholder"
     >
-    <!-- <button 
-      v-if="value"
-      :class="classes.searchClear" 
-      @click="clear"
-      :aria-label="classes.searchClearIcon ? 'Clear Search' : false"
-      type="button" 
-    >
-      <span 
-        v-if="classes.searchClearIcon" 
-        :class="classes.searchClearIcon"
-        aria-hidden="true"
-      ></span>
-      <span v-else>
-        Clear
-      </span>
-    </button> -->
   </div>
 </template>
 
-<script>
-  let uid = 0;
-  export default {
-    name: 'UluFacetsSearch',
-    props: {
-      classes: Object,
-      modelValue: String,
-      placeholder: {
-        type: String,
-        default: "Keywords…"
-      }
-    },
-    data() {
-      return {
-        id: `facet-view-keyword-${ ++uid }`
-      }
+<script setup>
+  import { computed } from 'vue';
+
+  const props = defineProps({
+    classes: {
+      type: Object,
+      default: () => ({})
     },
-    computed: {
-      localValue: {
-        get() {
-          return this.modelValue;
-        },
-        set(val) {
-          this.$emit('update:modelValue', val);
-        }
-      }
+    modelValue: String,
+    placeholder: {
+      type: String,
+      default: "Keywords…"
+    }
+  });
+
+  const emit = defineEmits(['update:modelValue']);
+
+  let uid = 0;
+  const id = `facet-view-keyword-${++uid}`;
+
+  const localValue = computed({
+    get() {
+      return props.modelValue;
     },
-    methods: {
-      clear() {
-        // this.value = null;
-        // this.applied = false;
-        // this.$emit("search", null);
-      }
+    set(val) {
+      emit('update:modelValue', val);
     }
-  }
-</script>
+  });
+</script>

package/lib/components/systems/facets/UluFacetsSidebarLayout.vue

@@ -0,0 +1,31 @@
+<template>
+  <div class="UluFacetsSidebarLayout">
+    <div class="UluFacetsSidebarLayout__header">
+      <slot name="header"></slot>
+    </div>
+    <div class="UluFacetsSidebarLayout__body">
+      <div class="UluFacetsSidebarLayout__sidebar">
+        <slot name="sidebar"></slot>
+      </div>
+      <div class="UluFacetsSidebarLayout__main">
+        <slot name="main"></slot>
+      </div>
+    </div>
+  </div>
+</template>
+
+<script setup>
+// This component is purely for layout, no logic needed.
+</script>
+
+<style lang="scss">
+.UluFacetsSidebarLayout__body {
+  display: grid;
+  grid-template-columns: 1fr;
+  gap: 2rem;
+
+  @media (min-width: 768px) {
+    grid-template-columns: 250px 1fr;
+  }
+}
+</style>

package/lib/components/systems/facets/UluFacetsSort.vue

@@ -0,0 +1,45 @@
+<template>
+  <div class="UluFacetsSort" :class="classes.sortForm">
+    <label 
+      :for="sortId" 
+      :class="classes.sortFormLabel"
+    >
+      <slot>Sort:</slot>
+    </label>
+    <select 
+      :value="modelValue"
+      @change="emit('update:modelValue', $event.target.value)"
+      :id="sortId" 
+      :class="classes.sortFormSelect"
+    >
+      <option v-for="(item, key) in sortTypes" :value="key" :key="key">
+        {{ item.text }}
+      </option>
+    </select>
+  </div>
+</template>
+
+<script setup>
+  import { ref } from 'vue';
+
+  let idCounter = 0;
+
+  defineProps({
+    classes: {
+      type: Object,
+      default: () => ({})
+    },
+    sortTypes: {
+      type: Object,
+      default: () => ({})
+    },
+    modelValue: {
+      type: String,
+      default: ''
+    }
+  });
+
+  const emit = defineEmits(['update:modelValue']);
+
+  const sortId = ref(`ulu-facet-sort-${++idCounter}`);
+</script>

package/lib/components/systems/facets/_facets.scss

@@ -54,9 +54,8 @@ $config: (
   $prefix: selector.class("facets");
 
   #{ $prefix }__body {
-        .FacetView__body {
-        display: flex
-;
+    .FacetView__body {
+      display: flex;
     }
   }
 }

package/lib/components/systems/facets/_mock-data.js

@@ -0,0 +1,40 @@
+export const initialMockFacets = [
+  {
+    name: 'Category',
+    uid: 'category',
+    open: true,
+    children: [
+      { uid: 'cat1', label: 'Design' },
+      { uid: 'cat2', label: 'Development' },
+      { uid: 'cat3', label: 'Marketing' },
+      { uid: 'cat4', label: 'Business' },
+      { uid: 'cat5', label: 'Lifestyle' },
+      { uid: 'cat6', label: 'Technology' },
+    ]
+  },
+  {
+    name: 'Author',
+    uid: 'author',
+    open: true,
+    children: [
+      { uid: 'jane-doe', label: 'Jane Doe' },
+      { uid: 'john-smith', label: 'John Smith' },
+      { uid: 'peter-jones', label: 'Peter Jones' },
+    ]
+  }
+];
+
+export const mockItems = [
+  { id: 1, title: 'The Art of UI Design', description: 'A deep dive into creating beautiful user interfaces.', category: ['cat1', 'cat2'], author: ['jane-doe'], date: new Date(2023, 5, 15) },
+  { id: 2, title: 'Vue.js for Beginners', description: 'Getting started with the popular JavaScript framework.', category: ['cat2', 'cat6'], author: ['john-smith'], date: new Date(2023, 8, 22) },
+  { id: 3, title: 'Content Marketing Strategies', description: 'How to attract and retain customers with great content.', category: ['cat3'], author: ['peter-jones'], date: new Date(2022, 11, 10) },
+  { id: 4, title: 'Startup Funding 101', description: 'A guide to raising capital for your new venture.', category: ['cat4'], author: ['jane-doe'], date: new Date(2024, 1, 5) },
+  { id: 5, title: 'Minimalist Living', description: 'Declutter your life and find more happiness.', category: ['cat5'], author: ['john-smith'], date: new Date(2023, 3, 30) },
+  { id: 6, title: 'The Future of AI', description: 'Exploring the impact of artificial intelligence on society.', category: ['cat6'], author: ['peter-jones'], date: new Date(2024, 0, 1) },
+  { id: 7, title: 'Advanced CSS Techniques', description: 'Take your styling skills to the next level.', category: ['cat1', 'cat2'], author: ['jane-doe'], date: new Date(2023, 10, 18) },
+  { id: 8, title: 'Building a Scalable API', description: 'Best practices for designing and implementing APIs.', category: ['cat2', 'cat6'], author: ['john-smith'], date: new Date(2023, 7, 3) },
+  { id: 9, title: 'Social Media for Business', description: 'Leveraging social platforms for growth.', category: ['cat3'], author: ['peter-jones'], date: new Date(2022, 9, 14) },
+  { id: 10, title: 'Negotiation and Deal Making', description: 'Master the art of getting what you want.', category: ['cat4'], author: ['jane-doe'], date: new Date(2023, 6, 25) },
+  { id: 11, title: 'Healthy Eating Habits', description: 'A guide to a balanced and nutritious diet.', category: ['cat5'], author: ['john-smith'], date: new Date(2024, 2, 12) },
+  { id: 12, title: 'Quantum Computing Explained', description: 'A simple introduction to a complex topic.', category: ['cat6'], author: ['peter-jones'], date: new Date(2023, 9, 9) },
+];

package/lib/components/systems/facets/useFacets.js

@@ -0,0 +1,229 @@
+import { ref, computed, watch } from 'vue';
+import Fuse from 'fuse.js';
+
+/**
+ * Generates facet groups and their possible values from a list of items.
+ * @param {Array<Object>} allItems - The full list of items.
+ * @param {Array<Object>} facetFields - Configuration for which fields to create facets from.
+ * @returns {Array<Object>} The generated facet structure.
+ */
+function generateInitialFacets(allItems, facetFields) {
+  if (!facetFields || !Array.isArray(facetFields)) return [];
+  return facetFields.map(group => {
+    const allValues = new Set();
+    const getValue = group.getValue || (item => item[group.uid]);
+
+    allItems.forEach(item => {
+      const value = getValue(item);
+      if (Array.isArray(value)) {
+        value.forEach(v => v && allValues.add(v));
+      } else if (value) {
+        allValues.add(value);
+      }
+    });
+
+    const getLabel = group.getLabel || (value => value);
+
+    return {
+      ...group,
+      children: [...allValues].sort().map(value => ({
+        uid: value,
+        label: getLabel(value),
+        selected: false
+      }))
+    };
+  });
+}
+
+
+/**
+ * A composable for handling client-side faceted search, filtering, and sorting.
+ * @param {import('vue').Ref<Array<Object>>} allItems - A Vue ref containing the full list of items to be processed.
+ * @param {Object} options - Configuration options for the composable.
+ * @param {Array} [options.initialFacets] - The initial configuration for the facets. Can be generated automatically if `facetFields` is provided.
+ * @param {Array} [options.facetFields] - A simpler configuration to automatically generate facets from items. Each item can have `uid`, `name`, `open`, `getValue` and `getLabel`.
+ * @param {String} [options.initialSearchValue=''] - The initial value for the search input.
+ * @param {String} [options.initialSortType='az'] - The initial sort type.
+ * @param {Boolean} [options.noDefaultSorts=false] - If true, the default 'A-Z' and 'Z-A' sorts will not be included.
+ * @param {Object} [options.extraSortTypes={}] - Additional sort types to be merged with the default ones.
+ * @param {Object} [options.searchOptions={}] - Configuration options for Fuse.js.
+ * @param {Function} [options.getItemFacet] - A function to retrieve facet information from an item. Should always return an array of values.
+ * @param {Function} [options.getSortValue] - A function to get the value to sort by from an item.
+ */
+export function useFacets(allItems, options = {}) {
+  const defaultGetItemFacet = (item, uid) => {
+    const value = item[uid];
+    if (value === null || typeof value === 'undefined') return [];
+    return Array.isArray(value) ? value : [value];
+  };
+
+  const {
+    initialFacets,
+    facetFields,
+    initialSearchValue = '',
+    initialSortType = 'az',
+    noDefaultSorts = false,
+    extraSortTypes = {},
+    searchOptions: initialSearchOptions = {},
+    getItemFacet = defaultGetItemFacet,
+    getSortValue = item => (item.title || item.label || "")
+  } = options;
+
+  const sortAlpha = items => {
+    return items.sort((a, b) => {
+      const va = getSortValue(a);
+      const vb = getSortValue(b);
+      if (va && vb) {
+        return String(va).localeCompare(String(vb));
+      } else {
+        return va ? -1 : vb ? 1 : 0;
+      }
+    });
+  }
+  const defaultSorts = {
+    az: { text: "A-Z", sort: sortAlpha },
+    za: { text: "Z-A", sort: items => sortAlpha(items).reverse() },
+  };
+
+  // --- Helpers ---
+  function createFacets(initial) {
+    return (initial || []).map(group => ({
+      ...group,
+      open: group.open || false,
+      children: group.children.map(facet => ({
+        ...facet,
+        selected: facet.selected || false
+      })),
+      selectedCount: 0
+    }));
+  }
+
+  const generatedFacets = computed(() => {
+    if (!facetFields || !allItems.value?.length) return null;
+    return generateInitialFacets(allItems.value, facetFields);
+  });
+
+  // --- State ---
+  const facets = ref(createFacets(initialFacets || generatedFacets.value));
+  const searchValue = ref(initialSearchValue);
+  const selectedSort = ref(initialSortType);
+
+  // If using facetFields, watch for changes in items and regenerate facets
+  if (facetFields && !initialFacets) {
+    watch(generatedFacets, (newGeneratedFacets) => {
+      facets.value = createFacets(newGeneratedFacets);
+    });
+  }
+
+  // --- Computed ---
+  const sortTypes = computed(() => ({
+    ...(noDefaultSorts ? {} : defaultSorts),
+    ...extraSortTypes
+  }));
+
+  const searchOptions = computed(() => ({
+    shouldSort: true,
+    keys: ["title", "label", "description", "author"],
+    ...initialSearchOptions
+  }));
+
+  const selectedFacets = computed(() => {
+    const selected = [];
+    facets.value.forEach((group) => {
+      const { name, uid, children } = group;
+      let count = 0;
+      let added = false;
+      if (children) {
+        children.forEach(child => {
+          if (child.selected) {
+            ++count;
+            if (!added) {
+              selected.push({ uid, name, children: [] });
+              added = true;
+            }
+            selected[selected.length - 1].children.push(child);
+          }
+        });
+      }
+      group.selectedCount = count;
+    });
+    return selected;
+  });
+
+  const filteredItems = computed(() => {
+    if (!selectedFacets.value.length) {
+      return allItems.value;
+    }
+    return allItems.value.filter(item => {
+      // An item must match every active facet group
+      return selectedFacets.value.every(group => {
+        const itemFacetValues = getItemFacet(item, group.uid);
+        if (itemFacetValues && itemFacetValues.length) {
+          // An item can match any of the selected facets within a group
+          return group.children.some(facet => itemFacetValues.includes(facet.uid));
+        }
+        return false;
+      });
+    });
+  });
+
+  const searchedItems = computed(() => {
+    if (!searchValue.value?.length) {
+      return filteredItems.value;
+    }
+    const fuse = new Fuse(filteredItems.value, searchOptions.value);
+    return fuse.search(searchValue.value).map(result => result.item);
+  });
+
+  const displayItems = computed(() => {
+    const sortFn = sortTypes.value[selectedSort.value]?.sort;
+    if (typeof sortFn !== 'function') {
+      return searchedItems.value;
+    }
+    // The sort function should not mutate the original array
+    return sortFn([...searchedItems.value]);
+  });
+
+  // --- Methods ---
+  function clearFilters() {
+    facets.value.forEach(group => {
+      if (group.children) {
+        group.children.forEach(child => child.selected = false);
+      }
+    });
+  }
+
+  function handleFacetChange({ groupUid, facetUid, selected }) {
+    const group = facets.value.find(g => g.uid === groupUid);
+    if (group) {
+      // For single-select groups, deselect other options when a new one is selected.
+      if (!group.multiple && selected) {
+        group.children.forEach(f => {
+          if (f.uid !== facetUid) {
+            f.selected = false;
+          }
+        });
+      }
+      const facet = group.children.find(f => f.uid === facetUid);
+      if (facet) {
+        facet.selected = selected;
+      }
+    }
+  }
+
+  return {
+    // State
+    facets,
+    searchValue,
+    selectedSort,
+    sortTypes,
+
+    // Computed
+    displayItems,
+    selectedFacets,
+
+    // Methods
+    clearFilters,
+    handleFacetChange
+  };
+}

package/lib/components/systems/index.js

@@ -1,17 +1,28 @@
-export { default as UluFacets } from './facets/UluFacets.vue';
+export { useFacets } from './facets/useFacets.js';
+export { default as UluFacetsFilterLists } from './facets/UluFacetsFilterLists.vue';
+export { default as UluFacetsFilterPopovers } from './facets/UluFacetsFilterPopovers.vue';
+export { default as UluFacetsFilterSelects } from './facets/UluFacetsFilterSelects.vue';
+export { default as UluFacetsHeaderLayout } from './facets/UluFacetsHeaderLayout.vue';
+export { default as UluFacetsResults } from './facets/UluFacetsResults.vue';
 export { default as UluFacetsSearch } from './facets/UluFacetsSearch.vue';
+export { default as UluFacetsSidebarLayout } from './facets/UluFacetsSidebarLayout.vue';
+export { default as UluFacetsSort } from './facets/UluFacetsSort.vue';
 export { default as UluFacetsList } from './facets/UluFacetsList.vue';
+
 export { default as UluScrollAnchors } from './scroll-anchors/UluScrollAnchors.vue';
 export { default as UluScrollAnchorsNav } from './scroll-anchors/UluScrollAnchorsNav.vue';
 export { default as UluScrollAnchorsNavAnimated } from './scroll-anchors/UluScrollAnchorsNavAnimated.vue';
 export { default as UluScrollAnchorsSection } from './scroll-anchors/UluScrollAnchorsSection.vue';
+
 export { default as UluShowSkeleton } from './skeleton/UluShowSkeleton.vue';
 export { default as UluSkeletonContent } from './skeleton/UluSkeletonContent.vue';
 export { default as UluSkeletonMedia } from './skeleton/UluSkeletonMedia.vue';
-export { default as UluSkeletonTextInline } from './skeleton/UluSkeletonTextInline.vue';
+export { default as UluSkeletonText } from './skeleton/UluSkeletonText.vue';
+
 export { default as UluImageSlideShow } from './slider/UluImageSlideShow.vue';
 export { default as UluSlideShow } from './slider/UluSlideShow.vue';
 export { default as UluSlideShowSlide } from './slider/UluSlideShowSlide.vue';
+
 export { default as UluTableSticky } from './table-sticky/UluTableSticky.vue';
 export { default as UluTableStickyRows } from './table-sticky/UluTableStickyRows.vue';
 export { default as UluTableStickyTable } from './table-sticky/UluTableStickyTable.vue';

package/lib/components/systems/scroll-anchors/UluScrollAnchors.vue

@@ -10,6 +10,7 @@
   import { SECTIONS, REGISTER, UNREGISTER } from "./symbols.js";
   export default {
     name: "ScrollAnchors",
+    emits: ["section-change"],
     props: {
       firstItemActive: Boolean,
       /**
@@ -97,7 +98,7 @@
                 } else if (lastExiting && section.active) {
                   removeActive();
                 }
-                this.$emit("sectionChange", { 
+                this.$emit("section-change", { 
                   section, 
                   sections, 
                   active: isIntersecting 

package/lib/components/systems/skeleton/UluShowSkeleton.vue

@@ -1,13 +1,14 @@
 <template>
   <slot v-if="!when"/>
-  <SkeletonTextInline class="skeleton" v-else/>
+  <UluSkeletonText v-else inline/>
 </template>
 
-<script>
-  export default {
-    name: "ShowSkeleton",
-    props: {
-      when: Boolean,
-    },
-  };
+<script setup>
+  import UluSkeletonText from "./UluSkeletonText.vue";
+  defineProps({
+    /**
+     * If true will show whatever is passed to slot, else skeleton text
+     */
+    when: Boolean,
+  });
 </script>

package/lib/components/systems/skeleton/UluSkeletonContent.vue

@@ -1,11 +1,11 @@
 <template>
-  <div class="skeleton">
+  <div>
     <div v-for="(line, index) in linesWithSegments" :key="index">
       <span 
         v-for="segment in line"
         :key="segment"
-        class="skeleton__text skeleton__text--inline"
-        :class="{ 'skeleton__alt' : segment.alt }"
+        class="skeleton skeleton--text skeleton--inline"
+        :class="{ 'skeleton--background-alt' : segment.alt }"
         :style="{ width: `${ segment.width }%` }"
       > 
       </span>
@@ -13,48 +13,44 @@
   </div>
 </template>
 
-<script>
+<script setup>
+  import { computed } from "vue";
   import { randomInt } from "@ulu/utils/random.js";
   import { arrayCreate } from "@ulu/utils/array.js";
-  export default {
-    name: "SkeletonContent",
-    props: {
-      lines: {
-        type: Number,
-        default: 6
-      },
-    },
-    methods: {
-      randomInt
+
+  const props = defineProps({
+    /**
+     * Amount of lines to generate
+     */
+    lines: {
+      type: Number,
+      default: 6
     },
-    computed: {
-      /**
-       * Creates the segments (like words) for the given line count
-       * - Uses random number of segments and makes sure to fill the line between 70% - 100%
-       */
-      linesWithSegments() {
-        return arrayCreate(this.lines, () => {
-          const minWidth = 15;
-          const total = randomInt(70, 100);
-          let widthCurrent = 0;
-          const newWidth = () => {
-            const remaining = total - widthCurrent;
-            const width = randomInt(minWidth, remaining);
-            widthCurrent += width;
-            return width;
-          };
-          const segments = [];
-          while (widthCurrent < total - minWidth) {
-            segments.push(newWidth());
-          }
-          const getActualTotal = () => segments.reduce((acc, a) => acc + a, 0);
-          while (getActualTotal() >= total) {
-            let removed = segments.pop();
-            if (!removed) break;
-          }
-          return segments.map(width => ({ width, alt: Math.random() < 0.5 }));
-        });
-      }
+  });
+
+  /**
+   * Creates the segments (like words) for the given line count
+   * - Uses random number of segments and makes sure to fill the line between 70% - 100%
+   */
+  const linesWithSegments = computed(() => arrayCreate(props.lines, () => {
+    const minWidth = 15;
+    const total = randomInt(70, 100);
+    let widthCurrent = 0;
+    const newWidth = () => {
+      const remaining = total - widthCurrent;
+      const width = randomInt(minWidth, remaining);
+      widthCurrent += width;
+      return width;
+    };
+    const segments = [];
+    while (widthCurrent < total - minWidth) {
+      segments.push(newWidth());
+    }
+    const getActualTotal = () => segments.reduce((acc, a) => acc + a, 0);
+    while (getActualTotal() >= total) {
+      let removed = segments.pop();
+      if (!removed) break;
     }
-  };
+    return segments.map(width => ({ width, alt: Math.random() < 0.5 }));
+  }));
 </script>