@vcmap/ui 6.0.0-rc.1 → 6.0.0-rc.10

package/src/init.js

@@ -1,5 +1,5 @@
 import { createApp } from 'vue';
-import { check, checkMaybe, is } from '@vcsuite/check';
+import { check, is, maybe, oneOf, optional } from '@vcsuite/check';
 import { VcsModule } from '@vcmap/core';
 import VcsAppComponentWrapper from './application/VcsAppWrapper.vue';
 import VcsUiApp from './vcsUiApp.js';
@@ -15,23 +15,24 @@ const VcsObjectPattern = {
 
 /**
  * Base pattern to check VcsUiAppConfig
+ * @type {Record<string, import("@vcsuite/check").Pattern}
  */
 export const VcsUiAppConfigPattern = {
-  id: [undefined, String],
-  layers: [undefined, [VcsObjectPattern]],
-  maps: [undefined, [VcsObjectPattern]],
-  styles: [undefined, [VcsObjectPattern]],
-  viewpoints: [undefined, [VcsObjectPattern]],
-  startingViewpointName: [undefined, String],
-  startingMapName: [undefined, String],
-  projection: [undefined, Object],
-  categories: [undefined, [{ name: String, items: [Object] }]],
-  obliqueCollections: [undefined, [VcsObjectPattern]],
-  plugins: [undefined, [Object]],
-  contentTree: [undefined, [Object]],
-  uiConfig: [undefined, [Object]],
-  featureInfo: [undefined, [VcsObjectPattern]],
-  i18n: [undefined, [Object]],
+  id: optional(String),
+  layers: optional([VcsObjectPattern]),
+  maps: optional([VcsObjectPattern]),
+  styles: optional([VcsObjectPattern]),
+  viewpoints: optional([VcsObjectPattern]),
+  startingViewpointName: optional(String),
+  startingMapName: optional(String),
+  projection: optional(Object),
+  categories: optional([{ name: String, items: [Object] }]),
+  obliqueCollections: optional([VcsObjectPattern]),
+  plugins: optional([Object]),
+  contentTree: optional([Object]),
+  uiConfig: optional([Object]),
+  featureInfo: optional([VcsObjectPattern]),
+  i18n: optional([Object]),
 };
 
 /**
@@ -62,7 +63,7 @@ export default async function initApp(mountTarget) {
  */
 export async function initAppFromModule(mountTarget, configUrl) {
   check(mountTarget, String);
-  checkMaybe(configUrl, String);
+  check(configUrl, maybe(String));
 
   const app = await initApp(mountTarget);
   if (configUrl) {
@@ -90,7 +91,7 @@ export async function initAppFromAppConfig(mountTarget, appUrl) {
    */
   const appConfig = await fetch(appUrl).then((response) => response.json());
 
-  check(appConfig.modules, [String, Object]);
+  check(appConfig.modules, [oneOf(String, Object)]);
 
   const modules = await Promise.all(
     appConfig.modules.map(async (c) => {

package/src/legend/StyleLegendItem.vue

@@ -1,17 +1,13 @@
 <template>
-  <v-list density="compact">
-    <v-row>
+  <v-list class="style-legend-item">
+    <v-row no-gutters>
       <v-col
         v-for="(row, idx) in item.rows"
         :key="idx"
         :cols="cols"
         :class="{ 'w-100': item.colNr === 1, 'w-50': item.colNr !== 1 }"
       >
-        <v-list-item
-          density="compact"
-          class="pa-0"
-          :class="determineInnerPadding(idx)"
-        >
+        <v-list-item class="pa-0" :class="determineInnerPadding(idx)">
           <template #prepend>
             <v-img
               v-if="
@@ -20,7 +16,6 @@
               "
               width="32"
               height="24"
-              cover
               :src="getImageSrcFromShape(row.image)"
             />
             <svg
@@ -93,7 +88,7 @@
           </template>
 
           <v-list-item-title
-            class="pt-2"
+            class="pa-2"
             :title="$st(row.tooltip || row.title)"
           >
             {{ $st(row.title) }}

package/src/legend/VcsLegend.vue

@@ -1,56 +1,42 @@
 <template>
-  <v-sheet class="overflow-y-auto">
+  <v-sheet class="overflow-y-auto vcs-legend">
     <v-expansion-panels
       variant="accordion"
       multiple
       v-if="entries.length > 0"
       class="rounded-0"
     >
-      <v-expansion-panel
+      <vcs-expansion-panel
         v-for="(entry, i) in entries"
         :key="i"
-        class="px-2"
+        :heading="entry.title"
+        :header-actions="entry.actions"
         @group:selected="entry.open = !entry.open"
       >
-        <v-expansion-panel-title hide-actions>
-          <template #default="{ open }">
-            <div class="d-flex justify-space-between">
-              <div class="d-flex align-center">
-                <v-icon class="mr-1" :class="{ rotate: !open }">
-                  mdi-chevron-down
-                </v-icon>
-                {{ $st(entry.title) }}
-              </div>
-              <VcsActionButtonList :actions="entry.actions" />
+        <v-list class="pl-6 pb-2">
+          <div v-for="(item, idx) in entry.legend" :key="idx">
+            <div v-if="item.type === LegendType.Image">
+              <img
+                :src="$st(item.src)"
+                :alt="item.src"
+                class="legend-image"
+                :title="item.tooltip"
+              />
             </div>
-          </template>
-        </v-expansion-panel-title>
-        <v-expansion-panel-text class="pl-6 pb-2">
-          <v-list density="compact">
-            <div v-for="(item, idx) in entry.legend" :key="idx">
-              <div v-if="item.type === LegendType.Image">
-                <img
-                  :src="$st(item.src)"
-                  :alt="item.src"
-                  class="legend-image"
-                  :title="item.tooltip"
-                />
-              </div>
-              <div v-else-if="item.type === LegendType.Iframe">
-                <iframe
-                  :id="`legendIframe${idx}`"
-                  :src="$st(item.src)"
-                  scrolling="no"
-                  style="width: 100%; height: 100%"
-                  frameBorder="0"
-                  @load="setIframeHeight(`legendIframe${idx}`)"
-                />
-              </div>
-              <style-legend-item v-else :item="item" />
+            <div v-else-if="item.type === LegendType.Iframe">
+              <iframe
+                :id="`${cid}-legendIframe${idx}`"
+                :src="$st(item.src)"
+                scrolling="no"
+                style="width: 100%; height: 100%"
+                frameBorder="0"
+                @load="setIframeHeight(`${cid}-legendIframe${idx}`)"
+              />
             </div>
-          </v-list>
-        </v-expansion-panel-text>
-      </v-expansion-panel>
+            <style-legend-item v-else :item="item" />
+          </div>
+        </v-list>
+      </vcs-expansion-panel>
     </v-expansion-panels>
     <v-sheet v-else class="ma-2">
       {{ $t('legend.empty') }}
@@ -59,19 +45,12 @@
 </template>
 
 <script>
-  import {
-    VExpansionPanels,
-    VExpansionPanel,
-    VExpansionPanelText,
-    VExpansionPanelTitle,
-    VIcon,
-    VList,
-    VSheet,
-  } from 'vuetify/components';
+  import { VExpansionPanels, VList, VSheet } from 'vuetify/components';
   import { computed } from 'vue';
+  import { useComponentId } from '../components/composables.js';
   import { LegendType } from './legendHelper.js';
   import StyleLegendItem from './StyleLegendItem.vue';
-  import VcsActionButtonList from '../components/buttons/VcsActionButtonList.vue';
+  import VcsExpansionPanel from '../components/section/VcsExpansionPanel.vue';
 
   /**
    * @description A component rendering configured legend information for active layers.
@@ -81,13 +60,9 @@
   export default {
     name: 'VcsLegend',
     components: {
-      VcsActionButtonList,
+      VcsExpansionPanel,
       StyleLegendItem,
       VExpansionPanels,
-      VExpansionPanel,
-      VExpansionPanelText,
-      VExpansionPanelTitle,
-      VIcon,
       VList,
       VSheet,
     },
@@ -119,10 +94,13 @@
         set() {},
       });
 
+      const cid = useComponentId();
+
       return {
         LegendType,
         setIframeHeight,
         panels, // TODO
+        cid,
       };
     },
   };

package/src/legend/VcsLegend.vue.d.ts

@@ -11,6 +11,7 @@ declare const _default: import("vue").DefineComponent<{
     };
     setIframeHeight: (id: string) => void;
     panels: import("vue").ComputedRef<number[]>;
+    cid: string;
 }, any, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
     entries: {
         type: ArrayConstructor;

package/src/manager/buttonManager.js

@@ -1,7 +1,7 @@
 import { reactive } from 'vue';
 import { VcsEvent } from '@vcmap/core';
 import { v4 as uuidv4 } from 'uuid';
-import { check, checkMaybe } from '@vcsuite/check';
+import { check, maybe, oneOf } from '@vcsuite/check';
 import { vcsAppSymbol } from '../pluginHelper.js';
 import { ActionPattern } from '../components/lists/VcsActionList.vue';
 import { getActionFromOptions } from '../actions/actionHelper.js';
@@ -101,10 +101,10 @@ class ButtonManager {
    * @returns {ButtonComponent}
    */
   add(buttonComponentOptions, owner) {
-    checkMaybe(buttonComponentOptions.id, String);
-    checkMaybe(buttonComponentOptions.weight, Number);
+    check(buttonComponentOptions.id, maybe(String));
+    check(buttonComponentOptions.weight, maybe(Number));
     check(buttonComponentOptions.action, ActionPattern);
-    check(owner, [String, vcsAppSymbol]);
+    check(owner, oneOf(String, vcsAppSymbol));
 
     if (buttonComponentOptions.id && this.has(buttonComponentOptions.id)) {
       throw new Error(

package/src/manager/collectionManager/CollectionComponent.vue

@@ -1,39 +1,25 @@
 <template>
-  <v-expansion-panel>
-    <v-expansion-panel-title hide-actions class="px-2">
-      <div class="d-flex justify-space-between">
-        <div class="d-flex align-center gc-1">
-          <v-icon :class="{ rotate: !open }"> mdi-chevron-down </v-icon>
-          <span>
-            {{ $st(title) }}
-          </span>
-          <span v-if="selectable && selection.length > 0">
-            {{ `(${selection.length})` }}
-          </span>
-        </div>
-        <VcsActionButtonList
-          v-if="actions?.length > 0"
-          :actions="actions"
-          :overflow-count="overflowCount"
-        />
-      </div>
-    </v-expansion-panel-title>
-    <v-expansion-panel-text class="pb-1">
+  <vcs-expansion-panel
+    class="collection-component"
+    :heading="title"
+    :header-actions="actions"
+    :action-button-list-overflow-count="overflowCount"
+  >
+    <template #header-append>
+      <span v-if="selectable && selection.length > 0" class="ml-1">
+        {{ `(${selection.length})` }}
+      </span>
+    </template>
+    <template #default>
       <CollectionComponentContent @openList="(id) => $emit('openList', id)" />
-    </v-expansion-panel-text>
-  </v-expansion-panel>
+    </template>
+  </vcs-expansion-panel>
 </template>
 
 <script>
   import { computed, inject } from 'vue';
-  import {
-    VIcon,
-    VExpansionPanel,
-    VExpansionPanelTitle,
-    VExpansionPanelText,
-  } from 'vuetify/components';
+  import VcsExpansionPanel from '../../components/section/VcsExpansionPanel.vue';
   import { createSelectionActions } from '../../components/lists/VcsList.vue';
-  import VcsActionButtonList from '../../components/buttons/VcsActionButtonList.vue';
   import CollectionComponentContent from './CollectionComponentContent.vue';
 
   /**
@@ -51,12 +37,8 @@
   export default {
     name: 'CollectionComponent',
     components: {
+      VcsExpansionPanel,
       CollectionComponentContent,
-      VcsActionButtonList,
-      VExpansionPanel,
-      VExpansionPanelTitle,
-      VExpansionPanelText,
-      VIcon,
     },
     props: {
       open: {
@@ -64,6 +46,7 @@
         default: false,
       },
     },
+    emits: ['openList'],
     setup(_props, { emit }) {
       /**
        * @type {CollectionComponentClass}
@@ -97,11 +80,4 @@
   };
 </script>
 
-<style lang="scss" scoped>
-  .rotate {
-    transform: rotate(-90deg);
-  }
-  .v-icon {
-    font-size: 16px;
-  }
-</style>
+<style lang="scss" scoped></style>

package/src/manager/collectionManager/CollectionComponent.vue.d.ts

@@ -9,12 +9,14 @@ declare const _default: import("vue").DefineComponent<{
     selectable: any;
     overflowCount: any;
     actions: import("vue").ComputedRef<any>;
-}, any, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
+}, any, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, "openList"[], "openList", import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
     open: {
         type: BooleanConstructor;
         default: boolean;
     };
-}>>, {
+}>> & {
+    onOpenList?: ((...args: any[]) => any) | undefined;
+}, {
     open: boolean;
 }, {}>;
 export default _default;

package/src/manager/collectionManager/CollectionComponentContent.vue

@@ -1,5 +1,5 @@
 <template>
-  <v-container class="py-0 px-0">
+  <v-container class="py-0 px-0 collection-component-content">
     <vcs-list
       :items="items.slice(0, limit)"
       :draggable="draggable"
@@ -36,13 +36,14 @@
    * @vue-event {string} openList
    */
   export default {
-    name: 'CollectionComponent',
+    name: 'CollectionComponentContent',
     components: {
       VcsButton,
       VcsList,
       VSheet,
       VContainer,
     },
+    emits: ['openList'],
     setup(_props, { emit }) {
       /**
        * @type {CollectionComponentClass}
@@ -89,12 +90,12 @@
 <style lang="scss" scoped>
   :deep(.v-list) {
     .v-list-item {
-      padding: 4px 8px 4px 28px;
+      padding-left: 24px;
+      padding-inline-start: 24px !important;
     }
     .v-list-item__selected {
-      border-left: solid 4px;
-      border-left-color: var(--v-primary-base);
-      padding-left: 24px !important;
+      padding-left: 20px !important;
+      padding-inline-start: 20px !important;
     }
   }
 </style>

package/src/manager/collectionManager/CollectionComponentContent.vue.d.ts

@@ -13,5 +13,7 @@ declare const _default: import("vue").DefineComponent<{}, {
         targetIndex: any;
     }): void;
     openCollectionComponentList(): void;
-}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{}>>, {}, {}>;
+}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, "openList"[], "openList", import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{}>> & {
+    onOpenList?: ((...args: any[]) => any) | undefined;
+}, {}, {}>;
 export default _default;

package/src/manager/collectionManager/CollectionComponentList.vue

@@ -1,11 +1,8 @@
 <template>
-  <div>
-    <div
-      v-if="!hideHeader"
-      class="v-expansion-panel-header px-2 v-expansion-panel-header--active"
-    >
-      <div class="d-flex justify-space-between">
-        <div class="d-flex align-center gc-1 pl-2">
+  <div class="collection-component-list">
+    <div v-if="!hideHeader" class="pr-2 pl-4 py-1">
+      <div class="d-flex justify-space-between inner-header">
+        <div class="d-flex align-center gc-1">
           <span>
             {{ $st(title) }}
           </span>
@@ -52,7 +49,7 @@
    * New position is derived from a target item in the collection.
    * This ensures correct movement, if rendered list is only a subset of the collection.
    * @param {import("./collectionComponentClass.js").default<Object>} collectionComponent
-   * @param {import("../../components/lists/VcsList.vue").VcsListItem} item
+   * @param {import("../../components/lists/VcsListItemComponent.vue").VcsListItem} item
    * @param {number} targetIndex
    */
   export function moveItem(collectionComponent, item, targetIndex) {
@@ -93,6 +90,7 @@
       VcsList,
       VSheet,
     },
+    emits: ['closeList'],
     setup(_props, { emit }) {
       /**
        * @type {import("./collectionComponentClass.js").CollectionComponentClass}
@@ -136,4 +134,8 @@
   };
 </script>
 
-<style lang="scss" scoped></style>
+<style lang="scss" scoped>
+  .inner-header {
+    height: calc(var(--v-vcs-font-size) * 2 - 2px);
+  }
+</style>

package/src/manager/collectionManager/CollectionComponentList.vue.d.ts

@@ -3,10 +3,10 @@
  * New position is derived from a target item in the collection.
  * This ensures correct movement, if rendered list is only a subset of the collection.
  * @param {import("./collectionComponentClass.js").default<Object>} collectionComponent
- * @param {import("../../components/lists/VcsList.vue").VcsListItem} item
+ * @param {import("../../components/lists/VcsListItemComponent.vue").VcsListItem} item
  * @param {number} targetIndex
  */
-export function moveItem(collectionComponent: import("./collectionComponentClass.js").default<Object>, item: import("../../components/lists/VcsList.vue").VcsListItem, targetIndex: number): void;
+export function moveItem(collectionComponent: import("./collectionComponentClass.js").default<Object>, item: import("../../components/lists/VcsListItemComponent.vue").VcsListItem, targetIndex: number): void;
 declare const _default: import("vue").DefineComponent<{
     showLessButton: {
         type: BooleanConstructor;
@@ -31,7 +31,7 @@ declare const _default: import("vue").DefineComponent<{
         targetIndex: any;
     }): void;
     closeList(): void;
-}, any, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
+}, any, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, "closeList"[], "closeList", import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
     showLessButton: {
         type: BooleanConstructor;
         default: boolean;
@@ -40,7 +40,9 @@ declare const _default: import("vue").DefineComponent<{
         type: BooleanConstructor;
         default: boolean;
     };
-}>>, {
+}>> & {
+    onCloseList?: ((...args: any[]) => any) | undefined;
+}, {
     hideHeader: boolean;
     showLessButton: boolean;
 }, {}>;

package/src/manager/collectionManager/CollectionComponentProvider.vue

@@ -1,5 +1,5 @@
 <template>
-  <div class="w-100">
+  <div class="w-100 collection-component-provider">
     <slot>
       <collection-component />
     </slot>

package/src/manager/collectionManager/CollectionComponentStandalone.vue

@@ -4,6 +4,7 @@
     :header-actions="actions"
     :action-button-list-overflow-count="overflowCount"
     v-bind="{ ...$attrs }"
+    class="collection-component-standalone"
   >
     <collection-component-list
       v-if="componentListView"
@@ -16,7 +17,7 @@
 
 <script>
   import { computed, getCurrentInstance, inject, ref } from 'vue';
-  import VcsFormSection from '../../components/form-inputs-controls/VcsFormSection.vue';
+  import VcsFormSection from '../../components/section/VcsFormSection.vue';
   import { createSelectionActions } from '../../components/lists/VcsList.vue';
   import CollectionComponentList from './CollectionComponentList.vue';
   import CollectionComponentContent from './CollectionComponentContent.vue';
@@ -27,7 +28,7 @@
    * The collectionComponent must be passed via {@link https://vuejs.org/api/composition-api-dependency-injection.html |provide }.
    */
   export default {
-    name: 'CollectionComponent',
+    name: 'CollectionComponentStandalone',
     components: {
       CollectionComponentList,
       CollectionComponentContent,

package/src/manager/collectionManager/CollectionManager.vue

@@ -1,5 +1,5 @@
 <template>
-  <v-container class="pa-0">
+  <v-container class="pa-0 collection-manager">
     <v-expansion-panels
       variant="accordion"
       multiple

package/src/manager/collectionManager/categoryManager.d.ts

@@ -57,7 +57,7 @@ declare class CategoryManager extends CollectionManager implements ICategoryMana
      */
     requestCategory<T extends Object | import("@vcmap/core").VcsObject>(options: import("@vcmap/core").CategoryOptions<T>, owner: string | symbol, collectionComponentOptions?: import("./collectionComponentClass.js").CollectionComponentUiOptions): Promise<{
         collectionComponent: import("./collectionComponentClass.js").default<T>;
-        category: import("@vcmap/core").Category<T>;
+        category: import("@vcmap/core").Category<T, object>;
     }>;
     /**
      * Updates the filterFunction for added moduleIds.

package/src/manager/collectionManager/collectionComponentClass.d.ts

@@ -38,7 +38,7 @@ export type CollectionComponentUiOptions = {
 export type CollectionComponentClassOptions<T extends Object> = CollectionComponentUiOptions & {
     collection: import("@vcmap/core").Collection<T>;
 };
-export type CollectionComponentListItem = import("../../components/lists/VcsList.vue").VcsListItem & {
+export type CollectionComponentListItem = import("../../components/lists/VcsListItemComponent.vue").VcsListItem & {
     actions: Array<import("../../actions/actionHelper.js").VcsAction & {
         weight?: number;
     }>;
@@ -51,9 +51,9 @@ export type CollectionComponentListItem = import("../../components/lists/VcsList
  * Listens to all collection events and synchronizes changes to the items array.
  * The Collection Items will be transformed and filtered with the given itemMappings and itemFilter functions
  * @class
- * @template {Object|import("@vcmap/core").VcsObject} T
+ * @template {Object|import("@vcmap/core").VcsObject} [T=Object|import("@vcmap/core").VcsObject]
  */
-declare class CollectionComponentClass<T extends Object | import("@vcmap/core").VcsObject> {
+declare class CollectionComponentClass<T extends Object | import("@vcmap/core").VcsObject = Object | import("@vcmap/core").VcsObject> {
     /**
      * @param {CollectionComponentClassOptions<T>} options
      * @param {string|import("../../pluginHelper.js").vcsAppSymbol} owner