@vcmap/ui 6.3.11 → 7.0.0-rc.1

package/src/components/lists/VcsList.ts.vue.d.ts

@@ -0,0 +1,209 @@
+import type { PropType } from 'vue';
+import type { VcsAction } from '../../actions/actionHelper.js';
+import type { VcsListItem } from './VcsListItemComponent.ts.vue';
+import type { DropTargetZonesFunction } from './dragHelper.js';
+declare var __VLS_59: {
+    index: number;
+    item: VcsListItem;
+    actions: VcsAction[];
+    actionButtonListOverflowCount: number | undefined;
+    isActive: boolean;
+    isOpen: boolean;
+    isSelected: boolean;
+    isIndeterminate: boolean;
+    select: (value: boolean) => void;
+}, __VLS_62: {
+    index: number;
+    item: VcsListItem;
+    tooltip: string;
+    title?: string | number;
+}, __VLS_65: {
+    index: number;
+    item: VcsListItem;
+    subtitle?: string | number;
+}, __VLS_68: {
+    index: number;
+    item: VcsListItem;
+    isActive: boolean;
+    isOpen: boolean;
+    isSelected: boolean;
+    isIndeterminate: boolean;
+    select: (value: boolean) => void;
+}, __VLS_70: {
+    item: VcsListItem;
+    index: number;
+};
+type __VLS_Slots = {} & {
+    'item.append'?: (props: typeof __VLS_59) => any;
+} & {
+    'item.title'?: (props: typeof __VLS_62) => any;
+} & {
+    'item.subtitle'?: (props: typeof __VLS_65) => any;
+} & {
+    'item.prepend'?: (props: typeof __VLS_68) => any;
+} & {
+    'item.intermediate'?: (props: typeof __VLS_70) => any;
+};
+declare const __VLS_base: import("vue", { with: { "resolution-mode": "import" } }).DefineComponent<{
+    items: {
+        type: PropType<VcsListItem[]>;
+        required: true;
+    };
+    draggable: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    dropTargetZones: {
+        type: PropType<DropTargetZonesFunction | undefined>;
+        default: undefined;
+    };
+    selectable: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    singleSelect: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    selectFunction: {
+        type: PropType<(item: VcsListItem, event: PointerEvent) => void>;
+        default: undefined;
+    };
+    modelValue: {
+        type: PropType<Array<VcsListItem>>;
+        default: () => never[];
+    };
+    searchable: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    customFilter: {
+        type: PropType<(item: VcsListItem, query: string) => boolean>;
+        default: undefined;
+    };
+    searchbarPlaceholder: {
+        type: StringConstructor;
+        default: undefined;
+    };
+    showTitle: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    actionButtonListOverflowCount: {
+        type: NumberConstructor;
+        default: undefined;
+    };
+    title: {
+        type: StringConstructor;
+        default: string;
+    };
+    icon: {
+        type: StringConstructor;
+        default: undefined;
+    };
+    tooltip: {
+        type: StringConstructor;
+        default: string;
+    };
+    actions: {
+        type: PropType<VcsAction[]>;
+        required: false;
+        default: () => never[];
+    };
+}, unknown, unknown, {}, {}, import("vue", { with: { "resolution-mode": "import" } }).ComponentOptionsMixin, import("vue", { with: { "resolution-mode": "import" } }).ComponentOptionsMixin, {
+    "update:modelValue": (...args: any[]) => void;
+    itemMoved: (...args: any[]) => void;
+}, string, import("vue", { with: { "resolution-mode": "import" } }).PublicProps, Readonly<import("vue", { with: { "resolution-mode": "import" } }).ExtractPropTypes<{
+    items: {
+        type: PropType<VcsListItem[]>;
+        required: true;
+    };
+    draggable: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    dropTargetZones: {
+        type: PropType<DropTargetZonesFunction | undefined>;
+        default: undefined;
+    };
+    selectable: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    singleSelect: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    selectFunction: {
+        type: PropType<(item: VcsListItem, event: PointerEvent) => void>;
+        default: undefined;
+    };
+    modelValue: {
+        type: PropType<Array<VcsListItem>>;
+        default: () => never[];
+    };
+    searchable: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    customFilter: {
+        type: PropType<(item: VcsListItem, query: string) => boolean>;
+        default: undefined;
+    };
+    searchbarPlaceholder: {
+        type: StringConstructor;
+        default: undefined;
+    };
+    showTitle: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    actionButtonListOverflowCount: {
+        type: NumberConstructor;
+        default: undefined;
+    };
+    title: {
+        type: StringConstructor;
+        default: string;
+    };
+    icon: {
+        type: StringConstructor;
+        default: undefined;
+    };
+    tooltip: {
+        type: StringConstructor;
+        default: string;
+    };
+    actions: {
+        type: PropType<VcsAction[]>;
+        required: false;
+        default: () => never[];
+    };
+}>> & {
+    "onUpdate:modelValue"?: ((...args: any[]) => any) | undefined;
+    onItemMoved?: ((...args: any[]) => any) | undefined;
+}, {
+    title: string;
+    modelValue: VcsListItem[];
+    draggable: boolean;
+    tooltip: string;
+    icon: string;
+    selectable: boolean;
+    actions: VcsAction[];
+    customFilter: (item: VcsListItem, query: string) => boolean;
+    searchbarPlaceholder: string;
+    dropTargetZones: DropTargetZonesFunction | undefined;
+    actionButtonListOverflowCount: number;
+    singleSelect: boolean;
+    selectFunction: (item: VcsListItem, event: PointerEvent) => void;
+    searchable: boolean;
+    showTitle: boolean;
+}, {}>;
+declare const __VLS_export: __VLS_WithSlots<typeof __VLS_base, __VLS_Slots>;
+declare const _default: typeof __VLS_export;
+export default _default;
+type __VLS_WithSlots<T, S> = T & {
+    new (): {
+        $slots: S;
+    };
+};

package/src/components/lists/{VcsListItemComponent.vue → VcsListItemComponent.ts.vue}

@@ -1,37 +1,48 @@
-<script setup>
+<script setup lang="ts">
+  import type { PropType } from 'vue';
+  import { computed, ref } from 'vue';
   import {
     VListItem,
     VIcon,
     VListItemTitle,
     VTooltip,
   } from 'vuetify/components';
-  import { computed, ref } from 'vue';
   import { is } from '@vcsuite/check';
-  import VcsBadge from '../notification/VcsBadge.vue';
-  import VcsActionButtonList from '../buttons/VcsActionButtonList.vue';
-  import VcsTextField from '../form-inputs-controls/VcsTextField.vue';
+  import VcsBadge from '../notification/VcsBadge.ts.vue';
+  import VcsActionButtonList from '../buttons/VcsActionButtonList.ts.vue';
+  import VcsTextField from '../form-inputs-controls/VcsTextField.ts.vue';
   import { createEllipseTooltip } from '../composables.js';
+  import type { ActionOptions, VcsAction } from '../../actions/actionHelper.js';
 
-  /**
-   * @typedef {Object} VcsListItem
-   * @property {string} name
-   * @property {boolean} [visible] - Whether to display this item or not.
-   * @property {boolean} [disabled] - Whether this item should be displayed as disabled.
-   * @property {boolean|import("../../actions/actionHelper.js").ActionOptions} [renamable] - Whether the title of can be edited. will add a rename action to the end of the action list. This action will call titleChanged with the new title, you must provide the callback yourself, otherwise this does not work as expeted.
-   * @property {string} title - The title to be displayed
-   * @property {string} [tooltip]
-   * @property {string|HTMLCanvasElement|HTMLImageElement|undefined} [icon] - An optional icon to display with this item. Can be a URL or HTMLElement.
-   * @property {boolean} [hasUpdate] - Shows badge, if item has an update.
-   * @property {Array<import("../../actions/actionHelper.js").VcsAction>} [actions]
-   * @property {Array<function(PointerEvent):void>|undefined} [clickedCallbacks] - An array of callbacks called on item click. called before selection update
-   * @property {function(boolean):void} [selectionChanged] - A callback called if the selection changes with the current selection status. called before value update
-   * @property {function(string):void} [titleChanged] - A callback called if the title changes via rename action. only usable with renamble true.
-   */
+  export type VcsListItem = {
+    name: string;
+    /** Whether to display this item or not. */
+    visible?: boolean;
+    /** Whether this item should be displayed as disabled. */
+    disabled?: boolean;
+    /** Whether the title of can be edited. will add a rename action to the end of the action list. This action will call titleChanged with the new title, you must provide the callback yourself, otherwise this does not work as expeted. */
+    renamable?: boolean | ActionOptions;
+    /** The title to be displayed */
+    title: string;
+    /** An optional tooltip for the item. */
+    tooltip?: string;
+    /** An optional icon for the item. Can be a string, HTMLCanvasElement, or HTMLImageElement. */
+    icon?: string | HTMLCanvasElement | HTMLImageElement | undefined;
+    /** Whether the item has an update. */
+    hasUpdate?: boolean;
+    /** An array of actions associated with this item. */
+    actions?: Array<VcsAction>;
+    /** An array of callbacks called on item click. called before selection update */
+    clickedCallbacks?: Array<(event: PointerEvent) => void> | undefined;
+    /** A callback called if the selection changes with the current selection status. called before value update */
+    selectionChanged?: (selected: boolean) => void;
+    /** A callback called if the title changes via rename action. only usable with renamble true. */
+    titleChanged?: (newTitle: string) => void;
+  };
 
   const props = defineProps({
-    /** @type {VcsListItem} */
     item: {
-      type: Object,
+      type: Object as PropType<VcsListItem>,
       required: true,
     },
     actionButtonListOverflowCount: {
@@ -50,7 +61,7 @@
       return {
         name: 'list.renameItem',
         ...(is(props.item.renamable, Object) ? props.item.renamable : {}),
-        callback() {
+        callback(): void {
           rename.value = true;
         },
       };
@@ -58,7 +69,7 @@
     return undefined;
   });
 
-  function renameOff() {
+  function renameOff(): void {
     rename.value = false;
   }
 
@@ -81,7 +92,7 @@
     computed(() => props.item?.title),
   );
 
-  function renameItem(item, newTitle) {
+  function renameItem(item: VcsListItem, newTitle: string): void {
     if (newTitle) {
       item.titleChanged?.(newTitle);
     }
@@ -112,11 +123,11 @@
             v-if="rename"
             :model-value="item.title"
             autofocus
-            @update:model-value="(value) => renameItem(item, value)"
+            @update:model-value="(value: string) => renameItem(item, value)"
             @click.stop
             @keydown.enter="renameOff"
             @blur="renameOff"
-            :rules="[(v) => !!v || 'components.validation.required']"
+            :rules="[(v: string) => !!v || 'components.validation.required']"
             class="pa-0"
           />
           <template v-else>

package/src/components/lists/VcsListItemComponent.ts.vue.d.ts

@@ -0,0 +1,104 @@
+import type { PropType } from 'vue';
+import type { ActionOptions, VcsAction } from '../../actions/actionHelper.js';
+export type VcsListItem = {
+    name: string;
+    /** Whether to display this item or not. */
+    visible?: boolean;
+    /** Whether this item should be displayed as disabled. */
+    disabled?: boolean;
+    /** Whether the title of can be edited. will add a rename action to the end of the action list. This action will call titleChanged with the new title, you must provide the callback yourself, otherwise this does not work as expeted. */
+    renamable?: boolean | ActionOptions;
+    /** The title to be displayed */
+    title: string;
+    /** An optional tooltip for the item. */
+    tooltip?: string;
+    /** An optional icon for the item. Can be a string, HTMLCanvasElement, or HTMLImageElement. */
+    icon?: string | HTMLCanvasElement | HTMLImageElement | undefined;
+    /** Whether the item has an update. */
+    hasUpdate?: boolean;
+    /** An array of actions associated with this item. */
+    actions?: Array<VcsAction>;
+    /** An array of callbacks called on item click. called before selection update */
+    clickedCallbacks?: Array<(event: PointerEvent) => void> | undefined;
+    /** A callback called if the selection changes with the current selection status. called before value update */
+    selectionChanged?: (selected: boolean) => void;
+    /** A callback called if the title changes via rename action. only usable with renamble true. */
+    titleChanged?: (newTitle: string) => void;
+};
+declare var __VLS_9: {
+    isActive: boolean;
+    isOpen: boolean;
+    isSelected: boolean;
+    isIndeterminate: boolean;
+    select: (value: boolean) => void;
+}, __VLS_18: {
+    tooltip: string;
+    title?: string | number;
+}, __VLS_45: {
+    subtitle?: string | number;
+}, __VLS_48: {
+    tooltip: string;
+    isActive: boolean;
+    isOpen: boolean;
+    isSelected: boolean;
+    isIndeterminate: boolean;
+    select: (value: boolean) => void;
+}, __VLS_51: {
+    item: VcsListItem;
+    actions: VcsAction[];
+    actionButtonListOverflowCount: number | undefined;
+    isActive: boolean;
+    isOpen: boolean;
+    isSelected: boolean;
+    isIndeterminate: boolean;
+    select: (value: boolean) => void;
+};
+type __VLS_Slots = {} & {
+    prepend?: (props: typeof __VLS_9) => any;
+} & {
+    title?: (props: typeof __VLS_18) => any;
+} & {
+    subtitle?: (props: typeof __VLS_45) => any;
+} & {
+    default?: (props: typeof __VLS_48) => any;
+} & {
+    append?: (props: typeof __VLS_51) => any;
+};
+declare const __VLS_base: import("vue", { with: { "resolution-mode": "import" } }).DefineComponent<{
+    item: {
+        type: PropType<VcsListItem>;
+        required: true;
+    };
+    actionButtonListOverflowCount: {
+        type: NumberConstructor;
+        default: undefined;
+    };
+    dragging: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+}, unknown, unknown, {}, {}, import("vue", { with: { "resolution-mode": "import" } }).ComponentOptionsMixin, import("vue", { with: { "resolution-mode": "import" } }).ComponentOptionsMixin, {}, string, import("vue", { with: { "resolution-mode": "import" } }).PublicProps, Readonly<import("vue", { with: { "resolution-mode": "import" } }).ExtractPropTypes<{
+    item: {
+        type: PropType<VcsListItem>;
+        required: true;
+    };
+    actionButtonListOverflowCount: {
+        type: NumberConstructor;
+        default: undefined;
+    };
+    dragging: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+}>>, {
+    dragging: boolean;
+    actionButtonListOverflowCount: number;
+}, {}>;
+declare const __VLS_export: __VLS_WithSlots<typeof __VLS_base, __VLS_Slots>;
+declare const _default: typeof __VLS_export;
+export default _default;
+type __VLS_WithSlots<T, S> = T & {
+    new (): {
+        $slots: S;
+    };
+};