@fkui/vue 6.33.0 → 6.34.0

package/dist/esm/selectors.esm.js

@@ -0,0 +1,127 @@
+// src/selectors/FPaginator.selectors.ts
+function FPaginatorSelectors(selector = ".paginator") {
+  return Object.freeze({
+    /**
+     * The base selector for the component.
+     *
+     * This is the same selector that the consumer provided.
+     *
+     * @public
+     * @since v6.34.0
+     * @returns The root selector for the component.
+     */
+    get selector() {
+      return selector;
+    },
+    /**
+     * Get the button for the current page.
+     *
+     * @public
+     * @since v6.34.0
+     * @returns A selector for the currently active page button.
+     */
+    currentPageButton() {
+      return `${selector} .paginator__page--active`;
+    },
+    /**
+     * Get the button for the first page.
+     *
+     * @public
+     * @since v6.34.0
+     * @returns A selector for the button that navigates to the first
+     * page.
+     */
+    firstPageButton() {
+      return `${selector} [data-page~="first"]`;
+    },
+    /**
+     * Get the button for the last page.
+     *
+     * @public
+     * @since v6.34.0
+     * @returns A selector for the button that navigates to the last
+     * page.
+     */
+    lastPageButton() {
+      return `${selector} [data-page~="last"]`;
+    },
+    /**
+     * Get the button for navigating to the next page.
+     *
+     * @public
+     * @since v6.34.0
+     * @returns A selector for the button that navigates to the next
+     * page.
+     */
+    nextPageButton() {
+      return `${selector} .paginator__next`;
+    },
+    /**
+     * Get the button for a specific page by displayed text.
+     *
+     * This returns the button that displays the given text.
+     *
+     * @public
+     * @since v6.34.0
+     * @param text - The text displayed on the requested button. If a
+     * numeric value is provided, it is converted to a string.
+     * @returns A selector for the specified page button.
+     */
+    pageButtonByText(text) {
+      return `${selector} > [data-page~="${text}"]`;
+    },
+    /**
+     * Get the button for a specific page by index.
+     *
+     * The index starts at zero for the first button. A negative index
+     * selects buttons from the end, e.g. `-1` selects the last button.
+     *
+     * @public
+     * @since v6.34.0
+     * @param index - The zero-based page index, or a negative index to
+     * select from the end (e.g. `-1` selects the last button).
+     * @returns A selector for the specified page button.
+     */
+    pageButtonByIndex(index) {
+      return `${selector} > [data-index~="${index}"]`;
+    },
+    /**
+     * Get the buttons for all pages shown.
+     *
+     * @public
+     * @since v6.34.0
+     * @returns A selector for all displayed page buttons.
+     */
+    pageButtons() {
+      return `${selector} .paginator__page`;
+    },
+    /**
+     * Get the page counter element.
+     *
+     * The counter replaces the page buttons in compact mode on mobile
+     * devices.
+     *
+     * @public
+     * @since v6.34.0
+     * @returns A selector for the page counter element.
+     */
+    pageCounter() {
+      return `${selector} .paginator__page-counter`;
+    },
+    /**
+     * Get the button for navigating to the previous page.
+     *
+     * @public
+     * @since v6.34.0
+     * @returns A selector for the button that navigates to the previous
+     * page.
+     */
+    previousPageButton() {
+      return `${selector} .paginator__previous`;
+    }
+  });
+}
+export {
+  FPaginatorSelectors
+};
+//# sourceMappingURL=selectors.esm.js.map

package/dist/esm/selectors.esm.js.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../../src/selectors/FPaginator.selectors.ts"],
+  "sourcesContent": ["/**\n * Selectors for `FPaginator`.\n *\n * @public\n * @since v6.34.0\n * @param selector - The root selector of the FPaginator component.\n * @returns An object with selector methods for the FPaginator component.\n */\nexport function FPaginatorSelectors(selector: string = \".paginator\") {\n    return Object.freeze({\n        /**\n         * The base selector for the component.\n         *\n         * This is the same selector that the consumer provided.\n         *\n         * @public\n         * @since v6.34.0\n         * @returns The root selector for the component.\n         */\n        get selector(): string {\n            return selector;\n        },\n\n        /**\n         * Get the button for the current page.\n         *\n         * @public\n         * @since v6.34.0\n         * @returns A selector for the currently active page button.\n         */\n        currentPageButton(this: void): string {\n            return `${selector} .paginator__page--active`;\n        },\n\n        /**\n         * Get the button for the first page.\n         *\n         * @public\n         * @since v6.34.0\n         * @returns A selector for the button that navigates to the first\n         * page.\n         */\n        firstPageButton(this: void): string {\n            return `${selector} [data-page~=\"first\"]`;\n        },\n\n        /**\n         * Get the button for the last page.\n         *\n         * @public\n         * @since v6.34.0\n         * @returns A selector for the button that navigates to the last\n         * page.\n         */\n        lastPageButton(this: void): string {\n            return `${selector} [data-page~=\"last\"]`;\n        },\n\n        /**\n         * Get the button for navigating to the next page.\n         *\n         * @public\n         * @since v6.34.0\n         * @returns A selector for the button that navigates to the next\n         * page.\n         */\n        nextPageButton(this: void): string {\n            return `${selector} .paginator__next`;\n        },\n\n        /**\n         * Get the button for a specific page by displayed text.\n         *\n         * This returns the button that displays the given text.\n         *\n         * @public\n         * @since v6.34.0\n         * @param text - The text displayed on the requested button. If a\n         * numeric value is provided, it is converted to a string.\n         * @returns A selector for the specified page button.\n         */\n        pageButtonByText(this: void, text: number | string): string {\n            return `${selector} > [data-page~=\"${text}\"]`;\n        },\n\n        /**\n         * Get the button for a specific page by index.\n         *\n         * The index starts at zero for the first button. A negative index\n         * selects buttons from the end, e.g. `-1` selects the last button.\n         *\n         * @public\n         * @since v6.34.0\n         * @param index - The zero-based page index, or a negative index to\n         * select from the end (e.g. `-1` selects the last button).\n         * @returns A selector for the specified page button.\n         */\n        pageButtonByIndex(this: void, index: number | string): string {\n            return `${selector} > [data-index~=\"${index}\"]`;\n        },\n\n        /**\n         * Get the buttons for all pages shown.\n         *\n         * @public\n         * @since v6.34.0\n         * @returns A selector for all displayed page buttons.\n         */\n        pageButtons(this: void): string {\n            return `${selector} .paginator__page`;\n        },\n\n        /**\n         * Get the page counter element.\n         *\n         * The counter replaces the page buttons in compact mode on mobile\n         * devices.\n         *\n         * @public\n         * @since v6.34.0\n         * @returns A selector for the page counter element.\n         */\n        pageCounter(this: void): string {\n            return `${selector} .paginator__page-counter`;\n        },\n\n        /**\n         * Get the button for navigating to the previous page.\n         *\n         * @public\n         * @since v6.34.0\n         * @returns A selector for the button that navigates to the previous\n         * page.\n         */\n        previousPageButton(this: void): string {\n            return `${selector} .paginator__previous`;\n        },\n    });\n}\n"],
+  "mappings": ";AAQO,SAAS,oBAAoB,WAAmB,cAAc;AACjE,SAAO,OAAO,OAAO;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,IAUjB,IAAI,WAAmB;AACnB,aAAO;AAAA,IACX;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,IASA,oBAAsC;AAClC,aAAO,GAAG,QAAQ;AAAA,IACtB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,IAUA,kBAAoC;AAChC,aAAO,GAAG,QAAQ;AAAA,IACtB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,IAUA,iBAAmC;AAC/B,aAAO,GAAG,QAAQ;AAAA,IACtB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,IAUA,iBAAmC;AAC/B,aAAO,GAAG,QAAQ;AAAA,IACtB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,IAaA,iBAA6B,MAA+B;AACxD,aAAO,GAAG,QAAQ,mBAAmB,IAAI;AAAA,IAC7C;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,IAcA,kBAA8B,OAAgC;AAC1D,aAAO,GAAG,QAAQ,oBAAoB,KAAK;AAAA,IAC/C;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,IASA,cAAgC;AAC5B,aAAO,GAAG,QAAQ;AAAA,IACtB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,IAYA,cAAgC;AAC5B,aAAO,GAAG,QAAQ;AAAA,IACtB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,IAUA,qBAAuC;AACnC,aAAO,GAAG,QAAQ;AAAA,IACtB;AAAA,EACJ,CAAC;AACL;",
+  "names": []
+}

package/dist/types/cypress.d.ts

@@ -821,11 +821,12 @@ export declare class FPageHeaderPageobject implements BasePageObject {
  * @public
  */
 export declare class FPaginatorPageObject implements BasePageObject {
-    selector: string;
+    private _selectors;
     /**
      * @param selector - The root of the FPaginator component
      */
-    constructor(selector: string);
+    constructor(selector?: string);
+    get selector(): string;
     /**
      * Get the root element.
      *

package/dist/types/index.d.ts

@@ -2852,9 +2852,20 @@ disabled: {
 type: BooleanConstructor;
 required: false;
 };
+/**
+* Button size, can be one of:
+* - `small`
+* - `medium`
+* - `large`
+*/
+size: {
+type: PropType<"small" | "medium" | "large">;
+default: string;
+validator(value: string): boolean;
+};
 }>, {}, {}, {
 attrs(): Record<string, unknown>;
-labelClass(): string;
+labelClass(): string[];
 labelId(): string;
 ariaDisabled(): string | undefined;
 }, {
@@ -2877,9 +2888,21 @@ disabled: {
 type: BooleanConstructor;
 required: false;
 };
+/**
+* Button size, can be one of:
+* - `small`
+* - `medium`
+* - `large`
+*/
+size: {
+type: PropType<"small" | "medium" | "large">;
+default: string;
+validator(value: string): boolean;
+};
 }>> & Readonly<{
 onChange?: ((...args: any[]) => any) | undefined;
 }>, {
+size: "small" | "medium" | "large";
 disabled: boolean;
 id: string;
 }, {}, {
@@ -17479,6 +17502,16 @@ export declare function findElementFromVueRef(ref: unknown): Element | undefined
  */
 export declare function findHTMLElementFromVueRef(ref: unknown): HTMLElement | undefined;
 
+/**
+ * Get an identifier previously set by a call to `setItemIdentifier()` or `undefined`
+ * if no identifier was set.
+ *
+ * @public
+ * @since v6.34.0
+ * @param item - An item to get identifier from.
+ */
+export declare function findItemIdentifier(item: unknown): ItemIdentifier | undefined;
+
 /**
  * Finds and returns the parent component of given Vue component that matches given name.
  *
@@ -18023,8 +18056,23 @@ export declare function getInputElement(vm: {
     $el: Element;
 }): ValidatableHTMLElement;
 
-/** @public */
-export declare function getInternalKey<T>(): keyof T;
+/**
+ * Get an identifier previously set by a call to `setItemIdentifier()` or throws an error
+ * if no identifier was set.
+ *
+ * @public
+ * @since v6.34.0
+ * @param item - An item to get key from.
+ */
+export declare function getItemIdentifier(item: unknown): ItemIdentifier;
+
+/**
+ * Do not use. This only exists for backwards compatibility.
+ *
+ * @public
+ * @deprecated Use `getInternalKey(item)` instead.
+ */
+export declare function getLegacyInternalKey<T>(): keyof T;
 
 /**
  * Gets and returns the parent component of given Vue component that matches given name.
@@ -18172,6 +18220,14 @@ export declare const ISkipLink: typeof __VLS_export_78;
  */
 export declare function itemEquals<T extends object, K extends keyof T>(item1: T | undefined, item2: T | undefined, compareAttribute: K): boolean;
 
+/**
+ * Represents an item identifier used with `{get,set}ItemIdentifier()`.
+ *
+ * @public
+ * @since v6.34.0
+ */
+export declare type ItemIdentifier = string | number | symbol;
+
 /**
  * @public
  */
@@ -18554,18 +18610,31 @@ export declare interface RenderSlotOptions {
 export declare function renderSlotText(render: Slot | undefined, props?: Record<string, unknown>, options?: Partial<RenderSlotOptions>): string | undefined;
 
 /**
- * Recursively assigns internal keys to items (and optionally to nested item arrays).
+ * Set or generate an identifier for given item. The identifier should be unique
+ * within your set of data.
+ *
+ * If an identifier already exists it will *not* be overwritten.
+ *
+ * @public
+ * @since v6.34.0
+ * @param item - An item to set the identifier on.
+ * @param value - Specific identifier to use instead of generated one.
+ */
+export declare function setItemIdentifier(item: unknown, value?: ItemIdentifier): void;
+
+/**
+ * Recursively assigns identifiers to items (and optionally to nested items).
  *
  * @public
  * @param items - The array of items to process. Items are mutated in place.
- * @param keyAttribute - Optional property key on each item whose value should be used as the internal key. If omitted, an internal key is generated.
+ * @param attribute - Optional property on each item whose value should be used as the identifier. If omitted, an identifier is generated.
  * @param expandableAttribute - Optional property key on each item whose value is expected to be an array of nested items to process recursively.
  *
- * @throws Error If an item is missing or has an invalid value for `key` when `key` is provided.
- * @throws Error If a duplicate `key` value is encountered when `key` is provided.
- * @returns The same `items` array (with items mutated to include internal keys).
+ * @throws Error If an item is missing or has an invalid value for `attribute` when `attribute` is provided.
+ * @throws Error If a duplicate `attribute` value is encountered when `attribute` is provided.
+ * @returns The same `items` array (with items mutated to include identifiers).
  */
-export declare function setInternalKeys<T>(items: T[], keyAttribute?: keyof T, expandableAttribute?: keyof T, seenValues?: Set<unknown>): T[];
+export declare function setItemIdentifiers<T>(items: T[], attribute?: keyof T, expandableAttribute?: keyof T): T[];
 
 /**
  * @public

package/dist/types/selectors.d.ts

@@ -0,0 +1,110 @@
+/**
+ * Selectors for `FPaginator`.
+ *
+ * @public
+ * @since v6.34.0
+ * @param selector - The root selector of the FPaginator component.
+ * @returns An object with selector methods for the FPaginator component.
+ */
+export declare function FPaginatorSelectors(selector?: string): Readonly<{
+    /**
+     * The base selector for the component.
+     *
+     * This is the same selector that the consumer provided.
+     *
+     * @public
+     * @since v6.34.0
+     * @returns The root selector for the component.
+     */
+    readonly selector: string;
+    /**
+     * Get the button for the current page.
+     *
+     * @public
+     * @since v6.34.0
+     * @returns A selector for the currently active page button.
+     */
+    currentPageButton(this: void): string;
+    /**
+     * Get the button for the first page.
+     *
+     * @public
+     * @since v6.34.0
+     * @returns A selector for the button that navigates to the first
+     * page.
+     */
+    firstPageButton(this: void): string;
+    /**
+     * Get the button for the last page.
+     *
+     * @public
+     * @since v6.34.0
+     * @returns A selector for the button that navigates to the last
+     * page.
+     */
+    lastPageButton(this: void): string;
+    /**
+     * Get the button for navigating to the next page.
+     *
+     * @public
+     * @since v6.34.0
+     * @returns A selector for the button that navigates to the next
+     * page.
+     */
+    nextPageButton(this: void): string;
+    /**
+     * Get the button for a specific page by displayed text.
+     *
+     * This returns the button that displays the given text.
+     *
+     * @public
+     * @since v6.34.0
+     * @param text - The text displayed on the requested button. If a
+     * numeric value is provided, it is converted to a string.
+     * @returns A selector for the specified page button.
+     */
+    pageButtonByText(this: void, text: number | string): string;
+    /**
+     * Get the button for a specific page by index.
+     *
+     * The index starts at zero for the first button. A negative index
+     * selects buttons from the end, e.g. `-1` selects the last button.
+     *
+     * @public
+     * @since v6.34.0
+     * @param index - The zero-based page index, or a negative index to
+     * select from the end (e.g. `-1` selects the last button).
+     * @returns A selector for the specified page button.
+     */
+    pageButtonByIndex(this: void, index: number | string): string;
+    /**
+     * Get the buttons for all pages shown.
+     *
+     * @public
+     * @since v6.34.0
+     * @returns A selector for all displayed page buttons.
+     */
+    pageButtons(this: void): string;
+    /**
+     * Get the page counter element.
+     *
+     * The counter replaces the page buttons in compact mode on mobile
+     * devices.
+     *
+     * @public
+     * @since v6.34.0
+     * @returns A selector for the page counter element.
+     */
+    pageCounter(this: void): string;
+    /**
+     * Get the button for navigating to the previous page.
+     *
+     * @public
+     * @since v6.34.0
+     * @returns A selector for the button that navigates to the previous
+     * page.
+     */
+    previousPageButton(this: void): string;
+}>;
+
+export { }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fkui/vue",
-  "version": "6.33.0",
+  "version": "6.34.0",
   "description": "Vue implementation of FKUI components",
   "keywords": [
     "fkui",
@@ -27,6 +27,11 @@
       "require": "./dist/cjs/cypress.cjs.js",
       "import": "./dist/esm/cypress.esm.js"
     },
+    "./selectors": {
+      "types": "./dist/types/selectors.d.ts",
+      "require": "./dist/cjs/selectors.cjs.js",
+      "import": "./dist/esm/selectors.esm.js"
+    },
     "./htmlvalidate": "./htmlvalidate/index.cjs",
     "./htmlvalidate/cypress": "./htmlvalidate/cypress.js",
     "./package.json": "./package.json",
@@ -45,10 +50,11 @@
   ],
   "scripts": {
     "prebuild": "run-s clean",
-    "build": "run-s build:lib build:pageobjects build:dts build:api",
+    "build": "run-s build:lib build:pageobjects build:dts build:api build:test-bundles",
     "build:api": "fk-api-extractor --patch-augmentations --patch-declare-var-vls api-extractor.*.json",
     "build:dts": "vue-tsc -b",
     "build:lib": "fk-build-vue-lib",
+    "build:test-bundles": "node build-test-bundles.mjs",
     "build:pageobjects": "node build-pageobjects.mjs",
     "clean": "rimraf -g .jest-cache *.tsbuildinfo coverage dist public temp test-results",
     "prepack": "release-prepack --bundle --retain-scripts",
@@ -60,9 +66,9 @@
     "unit:watch": "jest --watch"
   },
   "peerDependencies": {
-    "@fkui/date": "^6.33.0",
-    "@fkui/design": "^6.33.0",
-    "@fkui/logic": "^6.33.0",
+    "@fkui/date": "^6.34.0",
+    "@fkui/design": "^6.34.0",
+    "@fkui/logic": "^6.34.0",
     "fk-icons": "^4.30.1",
     "html-validate": ">= 7.9.0",
     "vue": "^3.5.0"
@@ -79,5 +85,5 @@
     "node": ">= 20",
     "npm": ">= 7"
   },
-  "gitHead": "aefd7e006c712b409aae7893129f1cd3aa8d04cb"
+  "gitHead": "30c8ade65e70621c7d4d6c98aca6a1252f2ade5b"
 }