@fkui/vue 6.3.1 → 6.5.0

package/dist/types/index.d.ts

@@ -136,13 +136,190 @@ onUpdate?: (() => any) | undefined;
 }>, {}, {}, {}, {}, string, ComponentProvideOptions, false, {}, any>;
 
 declare const __VLS_component_4: DefineComponent<__VLS_Props_2, {}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, PublicProps, Readonly<__VLS_Props_2> & Readonly<{}>, {
-disabled: boolean;
 min: string;
 max: string;
 initial: string;
 }, {}, {}, {}, string, ComponentProvideOptions, false, {}, any>;
 
-declare const __VLS_component_5: DefineComponent<IPopupListboxProps, {}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {
+declare const __VLS_component_5: DefineComponent<ExtractPropTypes<    {
+/**
+* Unique (per-table) identifier. Typically set to the row
+* property displayed but any unique string can be used.
+*
+* Only required when used with `FSortFilterDataset`.
+*/
+name: {
+type: StringConstructor;
+default: undefined;
+};
+/**
+* If set to true, display the column, set to false to hide it.
+*/
+visible: {
+type: BooleanConstructor;
+default: boolean;
+};
+/**
+* If `true` this cell will be a row header (`<th>` as opposed to
+* `<td>`).
+*/
+rowHeader: {
+type: BooleanConstructor;
+required: false;
+default: boolean;
+};
+/**
+* Text to show in column header. In order to force newlines use `\n`.
+*/
+title: {
+type: StringConstructor;
+required: true;
+};
+/**
+* Additional column description.
+*/
+description: {
+type: StringConstructor;
+required: false;
+default: string;
+};
+/**
+* Set this column to shrink as small as possible.
+*
+* Cannot be combined with `expand`
+*/
+shrink: {
+type: BooleanConstructor;
+required: false;
+default: boolean;
+};
+/**
+* Set this column to expand as large as possible.
+*
+* Cannot be combined with `shrink`
+*
+* Default if neither `expand` or `shrink` is set.
+*/
+expand: {
+type: BooleanConstructor;
+required: false;
+default: boolean;
+};
+/**
+* Type of data the rows contains.
+*
+* Applies proper alignment and some styling (e.g. "numeric" uses fixed
+* width numbers).
+*
+* Can be one of the following values:
+*
+* - `"text"`: regular text data (default)
+* - `"date"`: date (should be YYYY-MM-DD)
+* - `"numeric"`: numeric data
+* - `"action"`: buttons to perform actions on row
+*/
+type: {
+type: PropType<"text" | "date" | "numeric" | "action">;
+required: false;
+default: FTableColumnType;
+validator(value: string): value is FTableColumnType;
+};
+}>, {}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, PublicProps, Readonly<ExtractPropTypes<    {
+/**
+* Unique (per-table) identifier. Typically set to the row
+* property displayed but any unique string can be used.
+*
+* Only required when used with `FSortFilterDataset`.
+*/
+name: {
+type: StringConstructor;
+default: undefined;
+};
+/**
+* If set to true, display the column, set to false to hide it.
+*/
+visible: {
+type: BooleanConstructor;
+default: boolean;
+};
+/**
+* If `true` this cell will be a row header (`<th>` as opposed to
+* `<td>`).
+*/
+rowHeader: {
+type: BooleanConstructor;
+required: false;
+default: boolean;
+};
+/**
+* Text to show in column header. In order to force newlines use `\n`.
+*/
+title: {
+type: StringConstructor;
+required: true;
+};
+/**
+* Additional column description.
+*/
+description: {
+type: StringConstructor;
+required: false;
+default: string;
+};
+/**
+* Set this column to shrink as small as possible.
+*
+* Cannot be combined with `expand`
+*/
+shrink: {
+type: BooleanConstructor;
+required: false;
+default: boolean;
+};
+/**
+* Set this column to expand as large as possible.
+*
+* Cannot be combined with `shrink`
+*
+* Default if neither `expand` or `shrink` is set.
+*/
+expand: {
+type: BooleanConstructor;
+required: false;
+default: boolean;
+};
+/**
+* Type of data the rows contains.
+*
+* Applies proper alignment and some styling (e.g. "numeric" uses fixed
+* width numbers).
+*
+* Can be one of the following values:
+*
+* - `"text"`: regular text data (default)
+* - `"date"`: date (should be YYYY-MM-DD)
+* - `"numeric"`: numeric data
+* - `"action"`: buttons to perform actions on row
+*/
+type: {
+type: PropType<"text" | "date" | "numeric" | "action">;
+required: false;
+default: FTableColumnType;
+validator(value: string): value is FTableColumnType;
+};
+}>> & Readonly<{}>, {
+type: "text" | "date" | "action" | "numeric";
+name: string;
+description: string;
+shrink: boolean;
+expand: boolean;
+visible: boolean;
+rowHeader: boolean;
+}, {}, {}, {}, string, ComponentProvideOptions, true, {
+element: unknown;
+}, any>;
+
+declare const __VLS_component_6: DefineComponent<IPopupListboxProps, {}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {
 close: () => any;
 }, string, PublicProps, Readonly<IPopupListboxProps> & Readonly<{
 onClose?: (() => any) | undefined;
@@ -177,10 +354,6 @@ declare type __VLS_Props = {
 };
 
 declare type __VLS_Props_2 = {
-    /**
-     * Disables resizing. The current size is locked.
-     */
-    disabled?: boolean;
     /**
      * Minimal size of pane.
      *
@@ -259,6 +432,17 @@ declare function __VLS_template_4(): {
 };
 
 declare function __VLS_template_5(): {
+    attrs: Partial<{}>;
+    slots: {
+        default?(_: {}): any;
+    };
+    refs: {
+        element: unknown;
+    };
+    rootEl: any;
+};
+
+declare function __VLS_template_6(): {
     attrs: Partial<{}>;
     slots: {
         default?(_: {}): any;
@@ -281,6 +465,8 @@ declare type __VLS_TemplateResult_4 = ReturnType<typeof __VLS_template_4>;
 
 declare type __VLS_TemplateResult_5 = ReturnType<typeof __VLS_template_5>;
 
+declare type __VLS_TemplateResult_6 = ReturnType<typeof __VLS_template_6>;
+
 declare type __VLS_WithTemplateSlots<T, S> = T & {
     new (): {
         $slots: S;
@@ -311,6 +497,12 @@ declare type __VLS_WithTemplateSlots_5<T, S> = T & {
     };
 };
 
+declare type __VLS_WithTemplateSlots_6<T, S> = T & {
+    new (): {
+        $slots: S;
+    };
+};
+
 /* Excluded from this release type: actionFromKeyboardEvent */
 
 /**
@@ -3297,19 +3489,33 @@ rotate: string;
 }, {}, string, ComponentProvideOptions, true, {}, any>;
 
 export declare const FCrudButton: DefineComponent<ExtractPropTypes<    {
+/**
+* The action to be performed by the button.
+* Must be one of the following values: "delete" or "modify".
+*/
 action: {
 type: StringConstructor;
 required: true;
 validator(value: string): boolean;
 };
+/**
+* Determines if an icon should be displayed on the button.
+*/
 icon: {
 type: BooleanConstructor;
 default: boolean;
 };
+/**
+* The item that the action will be performed on.
+*/
 item: {
 type: ObjectConstructor;
 required: true;
 };
+/**
+* Determines if the button should display a label.
+* If false, the button will use a visually hidden text for accessibility.
+*/
 label: {
 type: BooleanConstructor;
 default: boolean;
@@ -3320,19 +3526,33 @@ buttonText(): string;
 }, {
 executeAction(): void;
 }, ComponentOptions, ComponentOptionsMixin, {}, string, PublicProps, Readonly<ExtractPropTypes<    {
+/**
+* The action to be performed by the button.
+* Must be one of the following values: "delete" or "modify".
+*/
 action: {
 type: StringConstructor;
 required: true;
 validator(value: string): boolean;
 };
+/**
+* Determines if an icon should be displayed on the button.
+*/
 icon: {
 type: BooleanConstructor;
 default: boolean;
 };
+/**
+* The item that the action will be performed on.
+*/
 item: {
 type: ObjectConstructor;
 required: true;
 };
+/**
+* Determines if the button should display a label.
+* If false, the button will use a visually hidden text for accessibility.
+*/
 label: {
 type: BooleanConstructor;
 default: boolean;
@@ -3428,6 +3648,9 @@ export declare const FCrudDataset: <T>(__VLS_props: NonNullable<Awaited<typeof _
     slots: {
         default?(_: {}): any;
         'add-button'?(_: {}): any;
+        buttons?(_: {
+            buttonClasses: string[];
+        }): any;
         add?(_: {
             item: NonNullable<DistributeRef<[T | null] extends [Ref<any, any>] ? IfAny<Ref<any, any> & T, Ref<Ref<any, any> & T, Ref<any, any> & T>, Ref<any, any> & T> : Ref<UnwrapRef<T> | null, T | UnwrapRef<T> | null>>>;
         }): any;
@@ -3934,6 +4157,9 @@ export declare const FDataTable: <T extends object>(__VLS_props: NonNullable<Awa
     attrs: any;
     slots: {
         caption?(_: {}): any;
+        default?(_: {
+            row: {};
+        }): any;
         default?(_: {
             row: T;
         }): any;
@@ -6005,6 +6231,10 @@ type: NumberConstructor;
 required: false;
 default: number;
 };
+/**
+* Text template for the screen reader notification text.
+* Use `%VALUE%` as a placeholder for the number of notifications.
+*/
 screenReaderNotificationTemplate: {
 type: StringConstructor;
 required: false;
@@ -6054,6 +6284,10 @@ type: NumberConstructor;
 required: false;
 default: number;
 };
+/**
+* Text template for the screen reader notification text.
+* Use `%VALUE%` as a placeholder for the number of notifications.
+*/
 screenReaderNotificationTemplate: {
 type: StringConstructor;
 required: false;
@@ -6748,6 +6982,9 @@ type: StringConstructor;
 required: false;
 default: () => string;
 };
+/**
+* Disables the file selector.
+*/
 disabled: {
 type: BooleanConstructor;
 required: false;
@@ -6771,6 +7008,9 @@ type: StringConstructor;
 required: false;
 default: () => string;
 };
+/**
+* Disables the file selector.
+*/
 disabled: {
 type: BooleanConstructor;
 required: false;
@@ -6922,6 +7162,14 @@ type: PropType<FValidationFormCallback>;
 required: false;
 default(): void;
 };
+/**
+* List of buttons to display in the modal.
+* Each button is defined as an FModalButtonDescriptor with the following properties:
+* - `label` (String): The text displayed on the button.
+* - `event` (String): The event emitted when the button is clicked.
+* - `type` (String): The button type. Valid values are: "primary" or "secondary".
+* - `submitButton` (Boolean): Whether the button is a submit button.
+*/
 buttons: {
 type: PropType<FModalButtonDescriptor[]>;
 required: false;
@@ -7017,6 +7265,14 @@ type: PropType<FValidationFormCallback>;
 required: false;
 default(): void;
 };
+/**
+* List of buttons to display in the modal.
+* Each button is defined as an FModalButtonDescriptor with the following properties:
+* - `label` (String): The text displayed on the button.
+* - `event` (String): The event emitted when the button is clicked.
+* - `type` (String): The button type. Valid values are: "primary" or "secondary".
+* - `submitButton` (Boolean): Whether the button is a submit button.
+*/
 buttons: {
 type: PropType<FModalButtonDescriptor[]>;
 required: false;
@@ -7666,8 +7922,8 @@ export declare const FInteractiveTable: <T extends object, K extends keyof T>(__
     slots: {
         'row-description'?(_: {}): any;
         caption?(_: {}): any;
-        'checkbox-description'?(_: {
-            row: T;
+        default?(_: {
+            row: {};
         }): any;
         default?(_: {
             row: T;
@@ -7681,6 +7937,9 @@ export declare const FInteractiveTable: <T extends object, K extends keyof T>(__
         default?(_: {
             row: T;
         }): any;
+        'checkbox-description'?(_: {
+            row: T;
+        }): any;
         expandable?(_: {
             expandableRow: T;
             parentRow: T;
@@ -14055,191 +14314,14 @@ rotate: string;
 }, {}, string, ComponentProvideOptions, true, {}, any>;
 }, {}, string, ComponentProvideOptions, true, {}, any>;
 
-export declare const FTableColumn: DefineComponent<ExtractPropTypes<    {
-/**
-* Unique (per-table) identifier.
-*
-* Typically set to the row property displayed but any unique string can
-* be used.
-*/
-name: {
-type: StringConstructor;
-required: true;
-};
-/**
-* If set to true, display the column, set to false to hide it.
-*/
-visible: {
-type: BooleanConstructor;
-default: boolean;
-};
-/**
-* If `true` this cell will be a row header (`<th>` as opposed to
-* `<td>`).
-*/
-rowHeader: {
-type: BooleanConstructor;
-required: false;
-default: boolean;
-};
-/**
-* Text to show in column header. In order to force newlines use `\n`.
-*/
-title: {
-type: StringConstructor;
-required: true;
-};
-/**
-* Additional column description.
-*/
-description: {
-type: StringConstructor;
-required: false;
-default: string;
-};
-/**
-* Set this column to shrink as small as possible.
-*
-* Cannot be combined with `expand`
-*/
-shrink: {
-type: BooleanConstructor;
-required: false;
-default: boolean;
-};
-/**
-* Set this column to expand as large as possible.
-*
-* Cannot be combined with `shrink`
-*
-* Default if neither `expand` or `shrink` is set.
-*/
-expand: {
-type: BooleanConstructor;
-required: false;
-default: boolean;
-};
-/**
-* Type of data the rows contains.
-*
-* Applies proper alignment and some styling (e.g. "numeric" uses fixed
-* width numbers).
-*
-* Can be one of the following values:
-*
-* - `"text"`: regular text data (default)
-* - `"date"`: date (should be YYYY-MM-DD)
-* - `"numeric"`: numeric data
-* - `"action"`: buttons to perform actions on row
-*/
-type: {
-type: PropType<"text" | "date" | "numeric" | "action">;
-required: false;
-default: FTableColumnType;
-validator(value: string): value is FTableColumnType;
-};
-}>, Omit<FTableInterface, "textFieldTableMode">, {}, {
-classes(): string[];
-scope(): "row" | null;
-tagName(): "td" | "th";
-}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, PublicProps, Readonly<ExtractPropTypes<    {
-/**
-* Unique (per-table) identifier.
-*
-* Typically set to the row property displayed but any unique string can
-* be used.
-*/
-name: {
-type: StringConstructor;
-required: true;
-};
-/**
-* If set to true, display the column, set to false to hide it.
-*/
-visible: {
-type: BooleanConstructor;
-default: boolean;
-};
-/**
-* If `true` this cell will be a row header (`<th>` as opposed to
-* `<td>`).
-*/
-rowHeader: {
-type: BooleanConstructor;
-required: false;
-default: boolean;
-};
-/**
-* Text to show in column header. In order to force newlines use `\n`.
-*/
-title: {
-type: StringConstructor;
-required: true;
-};
-/**
-* Additional column description.
-*/
-description: {
-type: StringConstructor;
-required: false;
-default: string;
-};
-/**
-* Set this column to shrink as small as possible.
-*
-* Cannot be combined with `expand`
-*/
-shrink: {
-type: BooleanConstructor;
-required: false;
-default: boolean;
-};
-/**
-* Set this column to expand as large as possible.
-*
-* Cannot be combined with `shrink`
-*
-* Default if neither `expand` or `shrink` is set.
-*/
-expand: {
-type: BooleanConstructor;
-required: false;
-default: boolean;
-};
-/**
-* Type of data the rows contains.
-*
-* Applies proper alignment and some styling (e.g. "numeric" uses fixed
-* width numbers).
-*
-* Can be one of the following values:
-*
-* - `"text"`: regular text data (default)
-* - `"date"`: date (should be YYYY-MM-DD)
-* - `"numeric"`: numeric data
-* - `"action"`: buttons to perform actions on row
-*/
-type: {
-type: PropType<"text" | "date" | "numeric" | "action">;
-required: false;
-default: FTableColumnType;
-validator(value: string): value is FTableColumnType;
-};
-}>> & Readonly<{}>, {
-type: "text" | "date" | "action" | "numeric";
-description: string;
-shrink: boolean;
-expand: boolean;
-visible: boolean;
-rowHeader: boolean;
-}, {}, {}, {}, string, ComponentProvideOptions, true, {}, any>;
+export declare const FTableColumn: __VLS_WithTemplateSlots_5<typeof __VLS_component_5, __VLS_TemplateResult_5["slots"]>;
 
 /**
  * @public
  */
 export declare interface FTableColumnData {
     id: string;
-    name: string;
+    name?: string;
     title: string;
     description?: string;
     size: FTableColumnSize;
@@ -15563,6 +15645,10 @@ export declare interface FWizardApi {
 export declare type FWizardKey = string | number | symbol | boolean;
 
 export declare const FWizardStep: DefineComponent<ExtractPropTypes<    {
+/**
+* The title of the wizard step.
+* This will be displayed as the step's header.
+*/
 title: {
 type: StringConstructor;
 required: true;
@@ -15630,6 +15716,10 @@ afterAnimation(open: boolean): Promise<void>;
 beforeNextWrapper(): FValidationFormResult;
 beforeValidationWrapper(): FValidationFormResult;
 }, ComponentOptions, ComponentOptionsMixin, {}, string, PublicProps, Readonly<ExtractPropTypes<    {
+/**
+* The title of the wizard step.
+* This will be displayed as the step's header.
+*/
 title: {
 type: StringConstructor;
 required: true;
@@ -17268,7 +17358,7 @@ export declare interface IPopupErrorData {
     arrowOffset: number;
 }
 
-export declare const IPopupListbox: __VLS_WithTemplateSlots_5<typeof __VLS_component_5, __VLS_TemplateResult_5["slots"]>;
+export declare const IPopupListbox: __VLS_WithTemplateSlots_6<typeof __VLS_component_6, __VLS_TemplateResult_6["slots"]>;
 
 declare interface IPopupListboxProps {
     isOpen: boolean;
@@ -18170,6 +18260,56 @@ export declare interface UseModal {
  */
 export declare function useModal(): UseModal;
 
+/**
+ * Returned from `useResize()`.
+ *
+ * @public
+ */
+export declare interface UseResize {
+    /** current size of resize pane in px */
+    readonly size: Readonly<Ref<number>>;
+}
+
+/**
+ * Provides an API to control functionallity of an ancestor `FResizePane` component.
+ *
+ * @public
+ * @param options - Optional refs controlling behaviour.
+ */
+export declare function useResize(options?: UseResizeOptions): UseResize;
+
+/**
+ * Optional refs controlling behaviour of ancestor `FResizePanel` component.
+ *
+ * @public
+ */
+export declare interface UseResizeOptions {
+    /** When one or more components sets `enabled` to `true` the resize handle is enabled and the end user can drag it to resize the pane */
+    readonly enabled?: Readonly<Ref<boolean>>;
+    /** When one or more compoents set `visible` to `true` the resize pane is visible */
+    readonly visible?: Readonly<Ref<boolean>>;
+    /**
+     * When one or more components set `overlay` to `true` the resize pane is
+     * displayed as an overlay and instead of occupying space from ther layout
+     * areas it will be shown on top.
+     *
+     * The `offset` property can be used to set a static size of how much space
+     * it should occupy.
+     */
+    readonly overlay?: Readonly<Ref<boolean>>;
+    /**
+     * When `overlay` is enabled this sets how much static space (in px) the
+     * pane should occupy from the nearby layout areas, that is, how much of the
+     * pane should be static and how much is overlay.
+     *
+     * Consider a collapsable panel, by setting the offset to the width of the
+     * collapsed state and enabling overlay, the resize pane will occupy that
+     * amount of space and the rest of the pane will be positioned on
+     * top of the other layout areas.
+     */
+    readonly offset?: Readonly<Ref<number>>;
+}
+
 /**
  * @public
  */

package/dist/types/tsdoc-metadata.json

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

package/htmlvalidate/configs/recommended.js

@@ -13,5 +13,6 @@ module.exports = {
         "fkui/required-max-length": "error",
         "fkui/ftextfield-formatter-validation": "error",
         "fkui/no-template-modal": "error",
+        "fkui/ftablecolumn-name": "error",
     },
 };