@onereach/ui-components 2.70.0-beta.2131.0 → 2.70.0-beta.2159.0

package/src/components/or-card-collection-v3/OrCardCollection.stories3.ts

@@ -1,10 +1,12 @@
 import { action } from '@storybook/addon-actions';
 import { Meta, StoryFn } from '@storybook/vue3';
+import { ref } from 'vue-demi';
 import { OrIconV3 as OrIcon } from '../or-icon-v3';
 import OrCardCollectionDocs from './OrCardCollection.docs.mdx';
 import OrCardCollection from './OrCardCollection.vue';
-import { CardCollectionView } from './props';
-import { CardCollectionItem, CardCollectionSortHeader } from './types';
+import { defaultViewModes } from './props';
+import { OrCardV3 as OrCard } from '../or-card-v3';
+import { CardCollectionItem } from './types';
 
 export default {
   title: 'Components/Card Collection',
@@ -12,7 +14,7 @@ export default {
 
   argTypes: {
     // Slots
-    gridItem: {
+    item: {
       type: {
         name: 'string',
         required: true,
@@ -21,10 +23,9 @@ export default {
       control: { type: 'text' },
     },
 
-    listItem: {
+    header: {
       type: {
         name: 'string',
-        required: true,
       },
 
       control: { type: 'text' },
@@ -37,14 +38,14 @@ export default {
 
     view: {
       control: { type: 'select' },
-      options: Object.values(CardCollectionView),
+      options: defaultViewModes.map(mode => mode.view),
     },
 
     sort: {
       control: { type: 'object' },
     },
 
-    sortHeaders: {
+    sortOptions: {
       control: { type: 'object' },
     },
 
@@ -52,6 +53,14 @@ export default {
       control: { type: 'text' },
     },
 
+    searchPlaceholder: {
+      control: { type: 'text' },
+    },
+
+    searchDebounce: {
+      control: { type: 'number' },
+    },
+
     // Events
     viewChange: {
       table: { disable: true },
@@ -70,35 +79,48 @@ export default {
     docs: {
       page: OrCardCollectionDocs,
     },
+    layout: 'fullscreen',
   },
 } as Meta<typeof OrCardCollection>;
 
 const Template: StoryFn<typeof OrCardCollection> = (args) => ({
   components: {
     OrCardCollection,
+    OrCard,
     OrIcon,
   },
 
   setup() {
+    const sort = ref(args.sort);
+    const onSortChange = (newSort: string) => {
+      sort.value = newSort;
+      action('searchChange')(newSort);
+    };
+
     return {
       args,
+      sort,
+      onSortChange,
       onViewChange: action('viewChange'),
-      onSortChange: action('sortChange'),
       onSearchChange: action('searchChange'),
     };
   },
 
   template: `
-    <OrCardCollection
-      v-bind="args"
-      @viewChange="onViewChange"
-      @sortChange="onSortChange"
-      @searchChange="onSearchChange"
-    >
-      <template #gridItem="item">${args.gridItem}</template>
-      <template #listItem="item">${args.listItem}</template>
-      <template #addon>${args.addon}</template>
-    </OrCardCollection>
+    <div class="p-md bg-surface-1 dark:bg-surface-1-dark">
+      <OrCardCollection
+        v-bind="args"
+        :sort="sort"
+        @viewChange="onViewChange"
+        @sortChange="onSortChange"
+        @searchChange="onSearchChange"
+      >
+        <template #item="{item, mode}">
+          <OrCard>${args.item} ({{mode}})</OrCard>
+        </template>
+        <template #addon>${args.addon}</template>
+      </OrCardCollection>
+    </div>
   `,
 });
 
@@ -106,8 +128,7 @@ export const Default = Template.bind({});
 
 Default.args = {
   // Slots
-  gridItem: '{{ item.label }} (grid)',
-  listItem: '{{ item.label }} (list)',
+  item: '{{ item.label }}',
   addon: '<OrIcon icon="info" />',
 
   // Props
@@ -139,7 +160,7 @@ Default.args = {
     'Yankee',
     'Zulu',
   ], (item) => ({
-    id: item.toLowerCase(),
+    key: item.toLowerCase(),
     label: item,
   })),
 };
@@ -150,13 +171,208 @@ WithSorting.args = {
   ...Default.args,
 
   // Props
-  sortHeaders: Array.from<string, CardCollectionSortHeader>([
-    'Foo',
-    'Bar',
-    'Baz',
-    'Qux',
-  ], (item) => ({
-    value: item.toLowerCase(),
-    label: item,
-  })),
+  sort: 'bar',
+  sortOptions: [
+    {
+      label: 'Foo',
+      value: 'foo',
+    },
+    {
+      label: 'Bar',
+      value: 'bar',
+    },
+    {
+      label: 'Baz',
+      value: 'baz',
+    },
+    {
+      label: 'Qux',
+      value: 'qux',
+    },
+  ],
+};
+
+
+export const OverrideViewContainer: StoryFn<typeof OrCardCollection> = (args) => ({
+  components: {
+    OrCardCollection,
+    OrCard,
+  },
+
+  setup() {
+    return {
+      args,
+      onViewChange: action('viewChange'),
+      onSortChange: action('sortChange'),
+      onSearchChange: action('searchChange'),
+    };
+  },
+
+  template: `
+    <div class="p-md bg-surface-1 dark:bg-surface-1-dark">
+      <OrCardCollection
+        v-bind="args"
+        @viewChange="onViewChange"
+        @sortChange="onSortChange"
+        @searchChange="onSearchChange"
+      >
+      <template #header="{mode}">
+        ${args.header}
+      </template>
+      <template #grid="{items}">
+        <div class="grid grid-cols-3">
+          <OrCard
+            v-for="item in items"
+            :key="item.key"
+          >
+            {{ item.label }}
+          </OrCard>
+        </div>
+      </template>
+        <template #list="{items}">
+          <ul>
+            <li
+              v-for="item in items"
+              :key="item.key"
+            >
+              - {{ item.label }}
+            </li>
+          </ul>
+        </template>
+      </OrCardCollection>
+    </div>
+  `,
+});
+
+OverrideViewContainer.args = {
+  ...Default.args,
+  header: '<div class="typography-headline-3">Custom {{ mode }}</div>',
+};
+
+export const ExtraViewMode: StoryFn<typeof OrCardCollection> = (args) => ({
+  components: {
+    OrCardCollection,
+    OrCard,
+  },
+
+  setup() {
+    return {
+      args,
+      defaultViewModes,
+      onViewChange: action('viewChange'),
+      onSearchChange: action('searchChange'),
+    };
+  },
+
+  template: `
+    <div class="p-md bg-surface-1 dark:bg-surface-1-dark">
+      <OrCardCollection
+        v-bind="args"
+        :view-modes="[...defaultViewModes, {view: 'mymode', icon: 'timeline'}]"
+        @viewChange="onViewChange"
+        @searchChange="onSearchChange"
+      >
+        <template #item="{item, mode}">
+          <OrCard>${args.item} ({{mode}})</OrCard>
+        </template>
+        <template #mymode="{items}">
+          <div class="typography-headline-3">My view mode</div>
+          <div class="grid grid-cols-3">
+            <OrCard
+              v-for="item in items"
+              :key="item.key"
+            >
+              {{ item.label }} (timeline)
+            </OrCard>
+          </div>
+        </template>
+      </OrCardCollection>
+    </div>
+  `,
+});
+
+ExtraViewMode.args = {
+  ...Default.args,
+};
+
+export const WithLink: StoryFn<typeof OrCardCollection> = (args) => ({
+  components: {
+    OrCardCollection,
+    OrCard,
+    OrIcon,
+  },
+
+  setup() {
+    return {
+      args,
+      onViewChange: action('viewChange'),
+      onSortChange: action('sortChange'),
+      onSearchChange: action('searchChange'),
+    };
+  },
+
+  template: `
+    <div class="p-md bg-surface-1 dark:bg-surface-1-dark">
+      <OrCardCollection
+        v-bind="args"
+        @viewChange="onViewChange"
+        @sortChange="onSortChange"
+        @searchChange="onSearchChange"
+      >
+        <template #item="{item}">
+          <a href="#" @click.prevent><OrCard>${args.item}</OrCard></a>
+        </template>
+      </OrCardCollection>
+    </div>
+  `,
+});
+
+WithLink.args = {
+  ...Default.args,
+};
+
+export const EmptySearchResults: StoryFn<typeof OrCardCollection> = (args) => ({
+  components: {
+    OrCardCollection,
+    OrCard,
+    OrIcon,
+  },
+
+  setup() {
+    return {
+      args,
+      onViewChange: action('viewChange'),
+      onSortChange: action('sortChange'),
+      onSearchChange: action('searchChange'),
+    };
+  },
+
+  template: `
+    <div class="p-md h-screen bg-surface-1 dark:bg-surface-1-dark">
+      <OrCardCollection
+        v-bind="args"
+        @viewChange="onViewChange"
+        @sortChange="onSortChange"
+        @searchChange="onSearchChange"
+      >
+        <template #noSearchResults="{search}">
+          <p class="text-center typography-headline-3">No results for "{{search}}"</p>
+        </template>
+      </OrCardCollection>
+    </div>
+  `,
+});
+
+EmptySearchResults.args = {
+  ...Default.args,
+  search: 'My favorite ..',
+  items: [],
+};
+
+export const CustomizeSearch = Template.bind({});
+
+CustomizeSearch.args = {
+  ...Default.args,
+  searchPlaceholder: 'What you want to find today?',
+  searchDebounce: 0,
 };

package/src/components/or-card-collection-v3/OrCardCollection.vue

@@ -6,87 +6,120 @@
   >
     <div :class="toolbarStyles">
       <div :class="toolbarPanelStyles">
-        <template v-if="sortHeaders">
-          <OrSortHeader
-            v-for="header in sortHeaders"
-            :key="header.value"
-            v-model="proxySort"
-            :input-value="header.value"
+        <template v-if="sortOptions.length">
+          <OrButton
+            ref="sortButton"
+            variant="link"
+            color="inherit"
+            @click="sortMenu.toggle()"
           >
-            {{ header.label }}
-          </OrSortHeader>
+            {{ sortLabel }}
+            <OrIcon
+              v-if="sortMenu"
+              :icon="sortMenu.isOpen ? 'arrow_drop_up' : 'arrow_drop_down'"
+            />
+          </OrButton>
+          <OrMenu
+            ref="sortMenu"
+            :trigger="sortButton && sortButton.root"
+          >
+            <OrMenuItem
+              v-for="sortItem in sortOptions"
+              :key="sortItem"
+              @click="handleSort(sortItem.value)"
+            >
+              {{ sortItem.label }}
+            </OrMenuItem>
+          </OrMenu>
         </template>
       </div>
-
-      <div :class="toolbarPanelStyles">
-        <OrInput
-          v-model="proxySearch"
-          :type="'search'"
-          :placeholder="'Search'"
-          :size="'s'"
-        />
-
-        <OrIconButton
-          :icon="'grid_view'"
-          @click="switchToGridView()"
-        />
-
-        <OrIconButton
-          :icon="'view_list'"
-          @click="switchToListView()"
+      <div
+        :class="toolbarPanelStyles"
+      >
+        <OrSearch
+          :model-value="proxySearch"
+          class="md:w-[350px]"
+          :placeholder="searchPlaceholder"
+          :debounce="searchDebounce"
+          size="s"
+          @search="handleSearch"
         />
-
-        <slot name="addon" />
+        <div class="layout-row gap-sm">
+          <template v-if="viewModes.length > 1">
+            <OrIconButton
+              v-for="viewOption in viewModes"
+              :key="viewOption.view"
+              :icon="{icon: viewOption.icon, variant: viewOption.view === proxyView ? 'filled' : 'outlined'}"
+              @click="switchView(viewOption.view)"
+            />
+          </template>
+          <slot name="addon" />
+        </div>
       </div>
     </div>
-
-    <div :class="contentStyles">
-      <template v-if="proxyView === 'grid'">
-        <OrCard
-          v-for="item in items"
-          :key="item.id"
-        >
-          <slot
-            name="gridItem"
-            v-bind="item"
-          />
-        </OrCard>
-      </template>
-
-      <template v-if="proxyView === 'list'">
-        <OrCard
-          v-for="item in items"
-          :key="item.id"
-        >
+    <slot
+      name="header"
+      v-bind="{
+        items,
+        mode: proxyView,
+      }"
+    />
+    <slot
+      v-if="items.length"
+      :name="proxyView"
+      v-bind="{items}"
+    >
+      <OrCardCollectionView
+        :items="items"
+        :mode="proxyView"
+      >
+        <template v-slot:item="props">
           <slot
-            name="listItem"
-            v-bind="item"
+            name="item"
+            v-bind="props"
           />
-        </OrCard>
-      </template>
-    </div>
+        </template>
+      </OrCardCollectionView>
+    </slot>
+    <slot
+      v-else-if="items.length === 0 && proxySearch.length > 0"
+      name="noSearchResults"
+      v-bind="{search: proxySearch}"
+    >
+      No results
+    </slot>
   </div>
 </template>
 
 <script lang="ts">
 import { computed, defineComponent, PropType, ref, watch } from 'vue-demi';
 import { useClassAttribute } from '../../hooks';
-import { OrCardV3 as OrCard } from '../or-card-v3';
 import { OrIconButtonV3 as OrIconButton } from '../or-icon-button-v3';
-import { OrInputV3 as OrInput } from '../or-input-v3';
-import { OrSortHeaderV3 as OrSortHeader, SortHeaderModel } from '../or-sort-header-v3';
-import { CardCollectionView } from './props';
-import { CardCollectionContent, CardCollectionContentViews, CardCollectionRoot, CardCollectionToolbar, CardCollectionToolbarPanel } from './styles';
-import { CardCollectionItem, CardCollectionSortHeader } from './types';
+import { OrMenuV3 as OrMenu } from '../or-menu-v3';
+import { OrMenuItemV3 as OrMenuItem } from '../or-menu-item-v3';
+import { OrIconV3 as OrIcon } from '../or-icon-v3';
+import {
+  CardCollectionRoot,
+  CardCollectionToolbar,
+  CardCollectionToolbarPanel,
+} from './styles';
+import { CardCollectionItem, SortOption, ViewMode } from './types';
+import OrCardCollectionView from './OrCardCollectionView.vue3.vue';
+import { OrButtonV3 as OrButton } from '../or-button-v3';
+import { OrSearchV3 as OrSearch } from '../or-search-v3';
+import { defaultViewModes, gridView } from './props';
 
 export default defineComponent({
   name: 'OrCardCollection',
 
   components: {
-    OrCard,
+    OrCardCollectionView,
     OrIconButton,
-    OrInput,
-    OrSortHeader,
+    OrButton,
+    OrMenu,
+    OrMenuItem,
+    OrIcon,
+    OrSearch,
   },
 
   inheritAttrs: false,
@@ -98,24 +131,39 @@ export default defineComponent({
     },
 
     view: {
-      type: String as PropType<CardCollectionView>,
-      default: CardCollectionView.Grid,
+      type: String,
+      default: gridView.view,
+    },
+
+    viewModes: {
+      type: Array as PropType<ViewMode[]>,
+      default: () => defaultViewModes,
     },
 
     sort: {
-      type: Object as PropType<SortHeaderModel>,
+      type: String,
       default: undefined,
     },
 
-    sortHeaders: {
-      type: Array as PropType<CardCollectionSortHeader[]>,
-      default: undefined,
+    sortOptions: {
+      type: Array as PropType<SortOption[]>,
+      default: () => [],
     },
 
     search: {
+      type: String,
+      default: '',
+    },
+
+    searchPlaceholder: {
       type: String,
       default: undefined,
     },
+
+    searchDebounce: {
+      type: Number,
+      default: undefined,
+    },
   },
 
   emits: [
@@ -131,6 +179,8 @@ export default defineComponent({
   setup(props, context) {
     // Refs
     const root = ref<HTMLElement>();
+    const sortMenu = ref<typeof OrMenu>();
+    const sortButton = ref<typeof OrButton>();
 
     // Styles
     const classAttribute = useClassAttribute();
@@ -149,10 +199,9 @@ export default defineComponent({
       ...CardCollectionToolbarPanel,
     ]);
 
-    const contentStyles = computed(() => [
-      ...CardCollectionContent,
-      ...CardCollectionContentViews[proxyView.value],
-    ]);
+    const sortLabel = computed(() => {
+      return props.sortOptions.find(item => item.value === props.sort)?.label;
+    });
 
     // State
     const proxyView = ref(props.view);
@@ -160,12 +209,15 @@ export default defineComponent({
     const proxySearch = ref(props.search);
 
     // Methods
-    function switchToGridView(): void {
-      proxyView.value = CardCollectionView.Grid;
+    function switchView(view: string): void {
+      proxyView.value = view;
+    }
+    function handleSort(sort: string) {
+      proxySort.value = sort;
     }
 
-    function switchToListView(): void {
-      proxyView.value = CardCollectionView.List;
+    function handleSearch(search: string) {
+      proxySearch.value = search;
     }
 
     // Effects
@@ -195,15 +247,18 @@ export default defineComponent({
 
     return {
       root,
+      sortMenu,
+      sortButton,
       rootStyles,
       toolbarStyles,
       toolbarPanelStyles,
-      contentStyles,
       proxyView,
       proxySort,
       proxySearch,
-      switchToGridView,
-      switchToListView,
+      sortLabel,
+      switchView,
+      handleSort,
+      handleSearch,
     };
   },
 });

package/src/components/or-card-collection-v3/OrCardCollectionView.vue2.vue

@@ -0,0 +1,41 @@
+<template>
+  <div :class="contentStyles">
+    <slot
+      v-for="(item) in items"
+      name="item"
+      v-bind="{
+        item,
+        mode,
+      }"
+    >
+      {{ item.key }}
+    </slot>
+  </div>
+</template>
+<script lang="ts">
+import { defineComponent, computed, PropType } from 'vue-demi';
+import { CardCollectionContent, CardCollectionContentViews } from './styles';
+import { CardCollectionItem } from './types';
+import { DefaultCardCollectionViews } from './props';
+
+export default defineComponent({
+  name: 'OrCardCollectionView',
+  props: {
+    items: {
+      type: Array as PropType<CardCollectionItem[]>,
+      default: [] as CardCollectionItem[],
+    },
+    mode: {
+      type: String as PropType<DefaultCardCollectionViews>,
+      required: true,
+    },
+  },
+  setup(props) {
+    const contentStyles = computed(() => [
+      ...CardCollectionContent,
+      ...CardCollectionContentViews[props.mode],
+    ]);
+    return { contentStyles };
+  },
+});
+</script>