@fastkit/vue-utils - npm Package Compare versions

Comparing version 0.15.9 to 0.15.10

dist/vue-utils.d.ts

 import * as vue from 'vue';
-import { HTMLAttributes, Ref, PropType, ComponentPropsOptions, Prop, Events, ObjectEmitsOptions, EmitsOptions, VNode, VNodeTypes, VNodeChild, VNodeArrayChildren, Slots, SlotsType, DefineComponent, ComponentCustomOptions, ComponentPublicInstance, App, Directive } from 'vue';
+import { HTMLAttributes, Ref, PropType, ComponentPropsOptions, Prop, Events, ObjectEmitsOptions, EmitsOptions, VNode, VNodeTypes, VNodeChild, VNodeArrayChildren, Slots, SlotsType, DefineComponent, ComponentCustomOptions, ComponentPublicInstance, MaybeRefOrGetter, App, Directive } from 'vue';
 export { CSSProperties } from 'vue';
@@ -395,2 +395,54 @@ import { Mixin } from '@fastkit/helpers';
 declare function getClientIterableKey(obj: WeakKey): number | undefined;
+type IterableKeyDetectorCandidate = string;
+declare function registerIterableKeyDetectorCandidates(candidates: IterableKeyDetectorCandidate[], replace?: boolean): void;
+type IterableKeyResolver<T = unknown> = (item: T) => string | undefined;
+/**
+ * Settings of the List Item Enumeration Key Detector
+ */
+interface IterableKeyDetectorSettings<T = unknown> {
+    /**
+     * List of items
+     */
+    items: MaybeRefOrGetter<T[] | undefined>;
+    /**
+     * Detection criteria for item key
+     *
+     * - `string` If the item is an object, use the value of the specified property name as the key.
+     * - `IterableKeyResolver (Function)` Retrieve the key using a custom function.
+     * - `undefined` If the item is an object, detect the key from a list of candidates.
+     *
+     * @default undefined
+     */
+    itemKey?: MaybeRefOrGetter<string | IterableKeyResolver<T> | undefined>;
+    /**
+     * List of candidates for automatic detection
+     */
+    candidates?: MaybeRefOrGetter<IterableKeyDetectorCandidate[] | undefined>;
+}
+/**
+ * List Item Enumeration Key Detector
+ */
+interface IterableKeyDetector<T = unknown> {
+    /**
+     * List of items
+     */
+    get items(): T[];
+    /**
+     * Detect and return the key of enumerable items.
+     *
+     * @param item - item
+     * @param defaultValue - default value
+     */
+    detect<D extends string | undefined>(item: T, defaultValue?: D): string | D;
+}
+/**
+ * Initialize and retrieve the List Item Enumeration Key Detector
+ *
+ * @param settings - Settings of the List Item Enumeration Key Detector
+ * @returns List Item Enumeration Key Detector
+ *
+ * @see {@link IterableKeyDetectorSettings}
+ * @see {@link IterableKeyDetector}
+ */
+declare function useIterableKeyDetector<T = unknown>(settings: IterableKeyDetectorSettings<T>): IterableKeyDetector<T>;
 
@@ -405,2 +457,2 @@ declare function onAppUnmount<HostElement = any>(app: App<HostElement>, unmount: () => any): void;
 
-export { type Booleanish, BooleanishPropOption, ClientOnly, type ComponentInstanceType, type DefineSlotsType, type DefinedSlots, type EmitFn, type EmitsToProps, type ExposedComponent, type ExtractComponentPropTypes, type ExtractPropInput, FOCUSABLE_ATTRIBUTES_PROPS, FOCUSABLE_ATTRIBUTES_PROP_KEYS, FOCUSABLE_EMIT_OPTIONS_MOCK, type FocusableAttributesPropKey, type FocusableAttributesProps, type HTMLAttributesPropOptions, KEYBOARDABLE_ATTRIBUTES_PROPS, KEYBOARDABLE_EMIT_OPTIONS_MOCK, type KeyboardableAttributesProps, type MixedInRefs, type MixedInRefsProxy, type MixedInRefsProxyImpl, type Numberish, NumberishPropOption, POINTABLE_ATTRIBUTES_PROPS, POINTABLE_ATTRIBUTES_PROP_KEYS, POINTABLE_EMIT_OPTIONS_MOCK, type PointableAttributesPropKey, type PointableAttributesProps, type RawNumberProp, type RawRouteComponent, type RefOrGetterOrValue, type ReferencedComponent, type ReferencedComponentAPI, type ResolvedSlots, type RouteMatchedItem, type RouteQueryType, type SameRouteCheckOptions, type StyleValue, type TypedComponent, type TypedComponentAPI, type TypedSlot, type VNodeChildOrSlot, assignProps, cleanupEmptyVNodeChild, componentRef, createMockPathRoute, createPropsOptions, defineEmitsOptions, defineSlots, defineSlotsProps, defineTypedComponent, extractRouteMatchedItems, findVNodeChild, getClientIterableKey, getMergedRouteQuery, getQueryMergedLocation, getRouteMatchedComponents, getRouteQuery, htmlAttributesPropOptions, installDirective, isComponentCustomOptions, isFragment, isSameRoute, onAppUnmount, rawNumberProp, rawNumberPropType, refsProxy, removeTrailingSlash, renderSlotOrEmpty, renderVNodeChildOrSlotsOrEmpty, resolveBooleanish, resolveNumberish, resolveVNodeChildOrSlot, resolveVNodeChildOrSlots, trailingSlashRE };
+export { type Booleanish, BooleanishPropOption, ClientOnly, type ComponentInstanceType, type DefineSlotsType, type DefinedSlots, type EmitFn, type EmitsToProps, type ExposedComponent, type ExtractComponentPropTypes, type ExtractPropInput, FOCUSABLE_ATTRIBUTES_PROPS, FOCUSABLE_ATTRIBUTES_PROP_KEYS, FOCUSABLE_EMIT_OPTIONS_MOCK, type FocusableAttributesPropKey, type FocusableAttributesProps, type HTMLAttributesPropOptions, type IterableKeyDetector, type IterableKeyDetectorCandidate, type IterableKeyDetectorSettings, type IterableKeyResolver, KEYBOARDABLE_ATTRIBUTES_PROPS, KEYBOARDABLE_EMIT_OPTIONS_MOCK, type KeyboardableAttributesProps, type MixedInRefs, type MixedInRefsProxy, type MixedInRefsProxyImpl, type Numberish, NumberishPropOption, POINTABLE_ATTRIBUTES_PROPS, POINTABLE_ATTRIBUTES_PROP_KEYS, POINTABLE_EMIT_OPTIONS_MOCK, type PointableAttributesPropKey, type PointableAttributesProps, type RawNumberProp, type RawRouteComponent, type RefOrGetterOrValue, type ReferencedComponent, type ReferencedComponentAPI, type ResolvedSlots, type RouteMatchedItem, type RouteQueryType, type SameRouteCheckOptions, type StyleValue, type TypedComponent, type TypedComponentAPI, type TypedSlot, type VNodeChildOrSlot, assignProps, cleanupEmptyVNodeChild, componentRef, createMockPathRoute, createPropsOptions, defineEmitsOptions, defineSlots, defineSlotsProps, defineTypedComponent, extractRouteMatchedItems, findVNodeChild, getClientIterableKey, getMergedRouteQuery, getQueryMergedLocation, getRouteMatchedComponents, getRouteQuery, htmlAttributesPropOptions, installDirective, isComponentCustomOptions, isFragment, isSameRoute, onAppUnmount, rawNumberProp, rawNumberPropType, refsProxy, registerIterableKeyDetectorCandidates, removeTrailingSlash, renderSlotOrEmpty, renderVNodeChildOrSlotsOrEmpty, resolveBooleanish, resolveNumberish, resolveVNodeChildOrSlot, resolveVNodeChildOrSlots, trailingSlashRE, useIterableKeyDetector };

package.json

 {
   "name": "@fastkit/vue-utils",
-  "version": "0.15.9",
+  "version": "0.15.10",
   "description": "Utilities for efficient development of Vue applications.",
@@ -44,4 +44,4 @@ "keywords": [
     "@fastkit/helpers": "^0.14.5",
-    "@fastkit/visibility": "^0.14.5",
-    "@fastkit/ts-type-utils": "^0.2.1"
+    "@fastkit/ts-type-utils": "^0.2.1",
+    "@fastkit/visibility": "^0.14.5"
   },
@@ -48,0 +48,0 @@ "devDependencies": {

No alert changes

Improved metrics

Total package byte prevSize

91938

increased by14.93%

Lines of code

916

increased by18.65%

No dependency changes