@fkui/vue 6.38.0 → 6.39.0

package/dist/types/index.d.ts

@@ -44,7 +44,6 @@ import { Slots } from 'vue';
 import { StackHandle } from '@fkui/logic';
 import { TranslateFunction } from '@fkui/logic';
 import { UnwrapRef } from 'vue';
-import { UnwrapRefSimple } from '@vue/reactivity';
 import { ValidatableHTMLElement } from '@fkui/logic';
 import { ValidationConfigUpdateDetail } from '@fkui/logic';
 import { ValidatorConfigs } from '@fkui/logic';
@@ -326,7 +325,9 @@ declare const __VLS_base_3: DefineComponent<ExtractPropTypes<    {
 * Element to focus on when card is invalid. Set when using validation.
 */
 focusRef: {
-type: PropType<HTMLElement | null>;
+type: PropType<HTMLElement | {
+$el: HTMLElement;
+} | null>;
 required: false;
 default: null;
 };
@@ -343,7 +344,9 @@ default: () => string;
 * Element to focus on when card is invalid. Set when using validation.
 */
 focusRef: {
-type: PropType<HTMLElement | null>;
+type: PropType<HTMLElement | {
+$el: HTMLElement;
+} | null>;
 required: false;
 default: null;
 };
@@ -357,7 +360,9 @@ default: () => string;
 };
 }>> & Readonly<{}>, {
 id: string;
-focusRef: HTMLElement | null;
+focusRef: HTMLElement | {
+$el: HTMLElement;
+} | null;
 }, {}, {}, {}, string, ComponentProvideOptions, true, {}, any>;
 
 declare const __VLS_base_4: DefineComponent<    {}, {}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, PublicProps, Readonly<{}> & Readonly<{}>, {}, {}, {}, {}, string, ComponentProvideOptions, true, {}, any>;
@@ -5029,12 +5034,12 @@ FValidationForm: DefineComponent<ExtractPropTypes<    {
 beforeSubmit: {
 type: PropType<FValidationFormCallback>;
 required: false;
-default(): () => undefined;
+default(): () => void;
 };
 beforeValidation: {
 type: PropType<FValidationFormCallback>;
 required: false;
-default(): () => undefined;
+default(): () => void;
 };
 id: {
 type: StringConstructor;
@@ -5070,12 +5075,12 @@ onSubmit(event: Event): Promise<void>;
 beforeSubmit: {
 type: PropType<FValidationFormCallback>;
 required: false;
-default(): () => undefined;
+default(): () => void;
 };
 beforeValidation: {
 type: PropType<FValidationFormCallback>;
 required: false;
-default(): () => undefined;
+default(): () => void;
 };
 id: {
 type: StringConstructor;
@@ -6367,12 +6372,12 @@ declare const __VLS_export_40: <T extends FPageLayoutType>(__VLS_props: NonNulla
     __ctx?: Awaited<typeof __VLS_setup>;
 };
 
-declare const __VLS_export_41: <T>(__VLS_props: NonNullable<Awaited<typeof __VLS_setup>>["props"], __VLS_ctx?: __VLS_PrettifyLocal_7<Pick<NonNullable<Awaited<typeof __VLS_setup>>, "attrs" | "emit" | "slots">>, __VLS_exposed?: NonNullable<Awaited<typeof __VLS_setup>>["expose"], __VLS_setup?: Promise<{
+declare const __VLS_export_41: <T, TArray extends Dataset<T> | T[] = Dataset<T> | T[]>(__VLS_props: NonNullable<Awaited<typeof __VLS_setup>>["props"], __VLS_ctx?: __VLS_PrettifyLocal_7<Pick<NonNullable<Awaited<typeof __VLS_setup>>, "attrs" | "emit" | "slots">>, __VLS_exposed?: NonNullable<Awaited<typeof __VLS_setup>>["expose"], __VLS_setup?: Promise<{
     props: PublicProps & __VLS_PrettifyLocal_7<{
         /**
          * The items to be used. The items will be used in the given array order.
          */
-        items?: T[];
+        items?: TArray extends Dataset<infer U> ? Dataset<U> : TArray;
         /**
          * The number of items per page (at most).
          */
@@ -6389,7 +6394,7 @@ declare const __VLS_export_41: <T>(__VLS_props: NonNullable<Awaited<typeof __VLS
          * @param firstItemIndex - The index of the first item on the page.
          * @param lastItemIndex - The index of the last item on the page.
          */
-        fetchData?(firstItemIndex: number, lastItemIndex: number): T[] | Promise<T[]>;
+        fetchData?(firstItemIndex: number, lastItemIndex: number): (TArray extends Dataset<infer U> ? Dataset<U> : TArray) | Promise<TArray extends Dataset<infer U> ? Dataset<U> : TArray>;
     }> & (typeof globalThis extends {
         __VLS_PROPS_FALLBACK: infer P;
     } ? P : {});
@@ -6397,7 +6402,7 @@ declare const __VLS_export_41: <T>(__VLS_props: NonNullable<Awaited<typeof __VLS
     attrs: any;
     slots: {
         default?: (props: {
-            items: T[] | UnwrapRefSimple<T>[];
+            items: TArray extends Dataset<infer U> ? Dataset<U> : TArray;
             numberOfItems: number;
             currentPage: number;
             firstItemIndex: number;
@@ -6848,9 +6853,9 @@ rotate: string;
 }, {}, string, ComponentProvideOptions, true, {}, any>;
 }, {}, string, ComponentProvideOptions, true, {}, any>;
 
-declare const __VLS_export_47: <T>(__VLS_props: NonNullable<Awaited<typeof __VLS_setup>>["props"], __VLS_ctx?: __VLS_PrettifyLocal_8<Pick<NonNullable<Awaited<typeof __VLS_setup>>, "attrs" | "emit" | "slots">>, __VLS_exposed?: NonNullable<Awaited<typeof __VLS_setup>>["expose"], __VLS_setup?: Promise<{
-    props: PublicProps & __VLS_PrettifyLocal_8<FSortFilterDatasetProps<T> & {
-        onDatasetSorted?: ((items: T[]) => any) | undefined;
+declare const __VLS_export_47: <T, TArray extends Dataset<T> | T[] = Dataset<T> | T[]>(__VLS_props: NonNullable<Awaited<typeof __VLS_setup>>["props"], __VLS_ctx?: __VLS_PrettifyLocal_8<Pick<NonNullable<Awaited<typeof __VLS_setup>>, "attrs" | "emit" | "slots">>, __VLS_exposed?: NonNullable<Awaited<typeof __VLS_setup>>["expose"], __VLS_setup?: Promise<{
+    props: PublicProps & __VLS_PrettifyLocal_8<FSortFilterDatasetProps<TArray extends Dataset<infer U> ? Dataset<U> : TArray> & {
+        onDatasetSorted?: ((items: TArray extends Dataset<infer U> ? Dataset<U> : TArray) => any) | undefined;
         onUsedSortAttributes?: ((sortAttribute: SortOrder) => any) | undefined;
     }> & (typeof globalThis extends {
         __VLS_PROPS_FALLBACK: infer P;
@@ -6863,10 +6868,10 @@ declare const __VLS_export_47: <T>(__VLS_props: NonNullable<Awaited<typeof __VLS
         }) => any;
     } & {
         default?: (props: {
-            sortFilterResult: T[];
+            sortFilterResult: TArray extends Dataset<infer U> ? Dataset<U> : TArray;
         }) => any;
     };
-    emit: ((evt: "datasetSorted", items: T[]) => void) & ((evt: "usedSortAttributes", sortAttribute: SortOrder) => void);
+    emit: ((evt: "datasetSorted", items: TArray extends Dataset<infer U> ? Dataset<U> : TArray) => void) & ((evt: "usedSortAttributes", sortAttribute: SortOrder) => void);
 }>) => VNode & {
     __ctx?: Awaited<typeof __VLS_setup>;
 };
@@ -14627,7 +14632,7 @@ declare const __VLS_export_67: DefineComponent<ExtractPropTypes<    {
 beforeSubmit: {
 type: PropType<FValidationFormCallback>;
 required: false;
-default(): () => undefined;
+default(): typeof noop;
 };
 /**
 * If given, this function is called before the form data is validated and the `submit` event is emitted.
@@ -14635,7 +14640,7 @@ default(): () => undefined;
 beforeValidation: {
 type: PropType<FValidationFormCallback>;
 required: false;
-default(): () => undefined;
+default(): typeof noop;
 };
 /**
 * The id for the form id attribute.
@@ -14697,7 +14702,7 @@ onSubmit(event: Event): Promise<void>;
 beforeSubmit: {
 type: PropType<FValidationFormCallback>;
 required: false;
-default(): () => undefined;
+default(): typeof noop;
 };
 /**
 * If given, this function is called before the form data is validated and the `submit` event is emitted.
@@ -14705,7 +14710,7 @@ default(): () => undefined;
 beforeValidation: {
 type: PropType<FValidationFormCallback>;
 required: false;
-default(): () => undefined;
+default(): typeof noop;
 };
 /**
 * The id for the form id attribute.
@@ -15354,12 +15359,12 @@ FValidationForm: DefineComponent<ExtractPropTypes<    {
 beforeSubmit: {
 type: PropType<FValidationFormCallback>;
 required: false;
-default(): () => undefined;
+default(): () => void;
 };
 beforeValidation: {
 type: PropType<FValidationFormCallback>;
 required: false;
-default(): () => undefined;
+default(): () => void;
 };
 id: {
 type: StringConstructor;
@@ -15395,12 +15400,12 @@ onSubmit(event: Event): Promise<void>;
 beforeSubmit: {
 type: PropType<FValidationFormCallback>;
 required: false;
-default(): () => undefined;
+default(): () => void;
 };
 beforeValidation: {
 type: PropType<FValidationFormCallback>;
 required: false;
-default(): () => undefined;
+default(): () => void;
 };
 id: {
 type: StringConstructor;
@@ -17565,6 +17570,22 @@ export declare interface ContextMenuTextItem {
     iconLibrary?: string;
 }
 
+/**
+ * Dataset contains row metadata for components such as `FSortFilterDataset`
+ * and `FTable`.
+ *
+ * Use `useDatasetRef()` to create a new dataset.
+ *
+ * @public
+ * @since v6.39.0
+ */
+export declare type Dataset<T> = T[] & {
+    readonly [datasetSymbol]: true;
+    /* Excluded from this release type: __type */
+};
+
+declare const datasetSymbol: unique symbol;
+
 declare const _default: typeof __VLS_export_67;
 export { _default as FValidationForm }
 export { _default as IValidationForm }
@@ -18170,11 +18191,11 @@ export declare interface FSortFilterDatasetInterface<TKeys = PropertyKey> {
  */
 export declare type FSortFilterDatasetMountCallback<TKeys = PropertyKey> = (columnNames: TKeys[]) => void;
 
-declare interface FSortFilterDatasetProps<T> {
+declare interface FSortFilterDatasetProps<TArray> {
     /**
      * The data that you wish to sort or filter.
      */
-    data: T[];
+    data: TArray;
     /**
      * All the attributes you want to enable sorting for and the corresponding name to display in the dropdown.
      * Structured as `{attributeName: "Name for dropdown", secondAttributeName: "Name for dropdown"}`
@@ -18795,6 +18816,8 @@ export declare interface NavigationMenuItem {
     target?: string;
 }
 
+declare function noop(): void;
+
 /**
  * Opens a modal using the given component.
  *
@@ -19140,6 +19163,14 @@ export declare function useCombobox(inputRef: Readonly<ShallowRef<HTMLInputEleme
     closeDropdown: () => void;
 };
 
+/**
+ * Creates a dataset as a Vue ref.
+ *
+ * @public
+ * @since v6.39.0
+ */
+export declare function useDatasetRef<T>(initial?: T[]): Ref<Dataset<T>>;
+
 /**
  * @public
  */

package/dist/types/tsdoc-metadata.json

@@ -5,7 +5,7 @@
   "toolPackages": [
     {
       "packageName": "@microsoft/api-extractor",
-      "packageVersion": "7.57.3"
+      "packageVersion": "7.57.6"
     }
   ]
 }

package/htmlvalidate/rules/ftextfieldFormatterValidation.rule.js

@@ -11,7 +11,7 @@ const { getDocumentationUrl } = require("./common");
  * @property {Location} location Attribute location (key)
  */
 
-const matchVValidation = /^v-validation($|[.])/;
+const matchVValidation = /^v-validation($|\.)/;
 const validatorsWithFormatters = [
     "bankAccountNumber",
     "bankgiro",

package/htmlvalidate/rules/requiredmaxlength.rule.js

@@ -16,7 +16,7 @@ const formatters = [
     "plusgiro",
     "postalCode",
 ];
-const allowedTags = ["input", "f-text-field"];
+const allowedTags = new Set(["input", "f-text-field"]);
 
 class RequiredMaxLength extends Rule {
     documentation() {
@@ -36,12 +36,12 @@ class RequiredMaxLength extends Rule {
             const tagName = target.tagName;
             const valueOfType = target.getAttributeValue("type");
 
-            if (!allowedTags.includes(tagName)) {
+            if (!allowedTags.has(tagName)) {
                 return;
             }
 
-            for (let i = 0; i < elementAttrs.length; i++) {
-                attributeKeys.push(elementAttrs[i].key);
+            for (const elementAttr of elementAttrs) {
+                attributeKeys.push(elementAttr.key);
             }
             const validation = attributeKeys.find((attr) =>
                 attr.includes("v-validation"),

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fkui/vue",
-  "version": "6.38.0",
+  "version": "6.39.0",
   "description": "Vue implementation of FKUI components",
   "keywords": [
     "fkui",
@@ -66,9 +66,9 @@
     "unit:watch": "jest --watch"
   },
   "peerDependencies": {
-    "@fkui/date": "^6.38.0",
-    "@fkui/design": "^6.38.0",
-    "@fkui/logic": "^6.38.0",
+    "@fkui/date": "^6.39.0",
+    "@fkui/design": "^6.39.0",
+    "@fkui/logic": "^6.39.0",
     "fk-icons": "^4.30.1",
     "html-validate": ">= 7.9.0",
     "vue": "^3.5.0"
@@ -85,5 +85,5 @@
     "node": ">= 20",
     "npm": ">= 7"
   },
-  "gitHead": "ea8e50d8567159581a628106e93ac0e7c1d43a1b"
+  "gitHead": "dcb4ae0482dae1d80806b45900c8b80771de7372"
 }