@fkui/vue 6.1.0 → 6.3.0

package/dist/types/index.d.ts

@@ -129,7 +129,16 @@ id: string;
 focusRef: HTMLElement | null;
 }, {}, {}, {}, string, ComponentProvideOptions, true, {}, HTMLDivElement>;
 
-declare const __VLS_component_3: DefineComponent<IPopupListboxProps, {}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {
+declare const __VLS_component_3: DefineComponent<__VLS_Props, {}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, PublicProps, Readonly<__VLS_Props> & Readonly<{}>, {}, {}, {}, {}, 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, {
 close: () => any;
 }, string, PublicProps, Readonly<IPopupListboxProps> & Readonly<{
 onClose?: (() => any) | undefined;
@@ -160,6 +169,38 @@ declare type __VLS_PrettifyLocal_5<T> = {
 } & {};
 
 declare type __VLS_Props = {
+    layout: string;
+};
+
+declare type __VLS_Props_2 = {
+    /**
+     * Disables resizing. The current size is locked.
+     */
+    disabled?: boolean;
+    /**
+     * Minimal size of pane.
+     *
+     * Can be set in `px`, `%`  (percent of application layout total size)
+     * or both as a space-separated list, e.g. `200px 20%`.
+     */
+    min?: string;
+    /**
+     * Maximum size of pane.
+     *
+     * Can be set in `px`, `%`  (percent of application layout total size)
+     * or both as a space-separated list, e.g. `600px 50%`.
+     */
+    max?: string;
+    /**
+     * Initial size of pane used when the pane is used for the first time.
+     *
+     * Can be set in `px` or `%` (percent of application layout total
+     * size)
+     */
+    initial?: string;
+};
+
+declare type __VLS_Props_3 = {
     id: string;
     isOpen: boolean;
     options: string[];
@@ -198,6 +239,22 @@ declare function __VLS_template_2(): {
 };
 
 declare function __VLS_template_3(): {
+    attrs: Partial<{}>;
+    slots: Partial<Record<string, (_: {}) => any>>;
+    refs: {};
+    rootEl: any;
+};
+
+declare function __VLS_template_4(): {
+    attrs: Partial<{}>;
+    slots: {
+        default?(_: {}): any;
+    };
+    refs: {};
+    rootEl: any;
+};
+
+declare function __VLS_template_5(): {
     attrs: Partial<{}>;
     slots: {
         default?(_: {}): any;
@@ -216,6 +273,10 @@ declare type __VLS_TemplateResult_2 = ReturnType<typeof __VLS_template_2>;
 
 declare type __VLS_TemplateResult_3 = ReturnType<typeof __VLS_template_3>;
 
+declare type __VLS_TemplateResult_4 = ReturnType<typeof __VLS_template_4>;
+
+declare type __VLS_TemplateResult_5 = ReturnType<typeof __VLS_template_5>;
+
 declare type __VLS_WithTemplateSlots<T, S> = T & {
     new (): {
         $slots: S;
@@ -234,6 +295,18 @@ declare type __VLS_WithTemplateSlots_3<T, S> = T & {
     };
 };
 
+declare type __VLS_WithTemplateSlots_4<T, S> = T & {
+    new (): {
+        $slots: S;
+    };
+};
+
+declare type __VLS_WithTemplateSlots_5<T, S> = T & {
+    new (): {
+        $slots: S;
+    };
+};
+
 /* Excluded from this release type: actionFromKeyboardEvent */
 
 /**
@@ -844,7 +917,7 @@ required: false;
 default: boolean;
 };
 modelValue: {
-type: (StringConstructor | NumberConstructor)[];
+type: (StringConstructor | NumberConstructor | null)[];
 required: false;
 default: string;
 };
@@ -942,7 +1015,7 @@ required: false;
 default: boolean;
 };
 modelValue: {
-type: (StringConstructor | NumberConstructor)[];
+type: (StringConstructor | NumberConstructor | null)[];
 required: false;
 default: string;
 };
@@ -988,7 +1061,7 @@ onChange?: ((...args: any[]) => any) | undefined;
 }>, {
 type: string;
 id: string;
-modelValue: string | number;
+modelValue: string | number | null;
 inline: boolean;
 disabled: boolean;
 options: string[] | undefined;
@@ -1301,7 +1374,7 @@ required: false;
 default: boolean;
 };
 modelValue: {
-type: (StringConstructor | NumberConstructor)[];
+type: (StringConstructor | NumberConstructor | null)[];
 required: false;
 default: string;
 };
@@ -1399,7 +1472,7 @@ required: false;
 default: boolean;
 };
 modelValue: {
-type: (StringConstructor | NumberConstructor)[];
+type: (StringConstructor | NumberConstructor | null)[];
 required: false;
 default: string;
 };
@@ -1445,7 +1518,7 @@ onChange?: ((...args: any[]) => any) | undefined;
 }>, {
 type: string;
 id: string;
-modelValue: string | number;
+modelValue: string | number | null;
 inline: boolean;
 disabled: boolean;
 options: string[] | undefined;
@@ -2232,7 +2305,7 @@ required: false;
 default: boolean;
 };
 modelValue: {
-type: (StringConstructor | NumberConstructor)[];
+type: (StringConstructor | NumberConstructor | null)[];
 required: false;
 default: string;
 };
@@ -2330,7 +2403,7 @@ required: false;
 default: boolean;
 };
 modelValue: {
-type: (StringConstructor | NumberConstructor)[];
+type: (StringConstructor | NumberConstructor | null)[];
 required: false;
 default: string;
 };
@@ -2376,7 +2449,7 @@ onChange?: ((...args: any[]) => any) | undefined;
 }>, {
 type: string;
 id: string;
-modelValue: string | number;
+modelValue: string | number | null;
 inline: boolean;
 disabled: boolean;
 options: string[] | undefined;
@@ -3411,7 +3484,7 @@ required: false;
 default: boolean;
 };
 modelValue: {
-type: (StringConstructor | NumberConstructor)[];
+type: (StringConstructor | NumberConstructor | null)[];
 required: false;
 default: string;
 };
@@ -3509,7 +3582,7 @@ required: false;
 default: boolean;
 };
 modelValue: {
-type: (StringConstructor | NumberConstructor)[];
+type: (StringConstructor | NumberConstructor | null)[];
 required: false;
 default: string;
 };
@@ -3555,7 +3628,7 @@ onChange?: ((...args: any[]) => any) | undefined;
 }>, {
 type: string;
 id: string;
-modelValue: string | number;
+modelValue: string | number | null;
 inline: boolean;
 disabled: boolean;
 options: string[] | undefined;
@@ -4403,7 +4476,7 @@ required: false;
 default: boolean;
 };
 modelValue: {
-type: (StringConstructor | NumberConstructor)[];
+type: (StringConstructor | NumberConstructor | null)[];
 required: false;
 default: string;
 };
@@ -4501,7 +4574,7 @@ required: false;
 default: boolean;
 };
 modelValue: {
-type: (StringConstructor | NumberConstructor)[];
+type: (StringConstructor | NumberConstructor | null)[];
 required: false;
 default: string;
 };
@@ -4547,7 +4620,7 @@ onChange?: ((...args: any[]) => any) | undefined;
 }>, {
 type: string;
 id: string;
-modelValue: string | number;
+modelValue: string | number | null;
 inline: boolean;
 disabled: boolean;
 options: string[] | undefined;
@@ -5097,7 +5170,7 @@ default: () => string;
 * @model
 */
 modelValue: {
-type: StringConstructor;
+type: (StringConstructor | null)[];
 required: false;
 default: undefined;
 };
@@ -5149,7 +5222,7 @@ default: () => string;
 * @model
 */
 modelValue: {
-type: StringConstructor;
+type: (StringConstructor | null)[];
 required: false;
 default: undefined;
 };
@@ -5176,7 +5249,7 @@ onChange?: ((...args: any[]) => any) | undefined;
 "onUpdate:modelValue"?: ((...args: any[]) => any) | undefined;
 }>, {
 id: string;
-modelValue: string;
+modelValue: string | null;
 maxLength: number;
 extendedValidation: boolean;
 pasteErrorText: string;
@@ -5193,7 +5266,7 @@ required: false;
 default: boolean;
 };
 modelValue: {
-type: (StringConstructor | NumberConstructor)[];
+type: (StringConstructor | NumberConstructor | null)[];
 required: false;
 default: string;
 };
@@ -5291,7 +5364,7 @@ required: false;
 default: boolean;
 };
 modelValue: {
-type: (StringConstructor | NumberConstructor)[];
+type: (StringConstructor | NumberConstructor | null)[];
 required: false;
 default: string;
 };
@@ -5337,7 +5410,7 @@ onChange?: ((...args: any[]) => any) | undefined;
 }>, {
 type: string;
 id: string;
-modelValue: string | number;
+modelValue: string | number | null;
 inline: boolean;
 disabled: boolean;
 options: string[] | undefined;
@@ -9135,7 +9208,7 @@ required: false;
 default: boolean;
 };
 modelValue: {
-type: (StringConstructor | NumberConstructor)[];
+type: (StringConstructor | NumberConstructor | null)[];
 required: false;
 default: string;
 };
@@ -9233,7 +9306,7 @@ required: false;
 default: boolean;
 };
 modelValue: {
-type: (StringConstructor | NumberConstructor)[];
+type: (StringConstructor | NumberConstructor | null)[];
 required: false;
 default: string;
 };
@@ -9279,7 +9352,7 @@ onChange?: ((...args: any[]) => any) | undefined;
 }>, {
 type: string;
 id: string;
-modelValue: string | number;
+modelValue: string | number | null;
 inline: boolean;
 disabled: boolean;
 options: string[] | undefined;
@@ -9773,7 +9846,7 @@ required: false;
 default: boolean;
 };
 modelValue: {
-type: (StringConstructor | NumberConstructor)[];
+type: (StringConstructor | NumberConstructor | null)[];
 required: false;
 default: string;
 };
@@ -9871,7 +9944,7 @@ required: false;
 default: boolean;
 };
 modelValue: {
-type: (StringConstructor | NumberConstructor)[];
+type: (StringConstructor | NumberConstructor | null)[];
 required: false;
 default: string;
 };
@@ -9917,7 +9990,7 @@ onChange?: ((...args: any[]) => any) | undefined;
 }>, {
 type: string;
 id: string;
-modelValue: string | number;
+modelValue: string | number | null;
 inline: boolean;
 disabled: boolean;
 options: string[] | undefined;
@@ -10445,6 +10518,8 @@ href: string;
 }, {}, {}, {}, string, ComponentProvideOptions, true, {}, any>;
 }, {}, string, ComponentProvideOptions, true, {}, any>;
 
+export declare const FPageLayout: __VLS_WithTemplateSlots_3<typeof __VLS_component_3, __VLS_TemplateResult_3["slots"]>;
+
 export declare const FPercentTextField: DefineComponent<ExtractPropTypes<    {
 /**
 * The number of decimals to format number as.
@@ -10490,7 +10565,7 @@ required: false;
 default: boolean;
 };
 modelValue: {
-type: (StringConstructor | NumberConstructor)[];
+type: (StringConstructor | NumberConstructor | null)[];
 required: false;
 default: string;
 };
@@ -10588,7 +10663,7 @@ required: false;
 default: boolean;
 };
 modelValue: {
-type: (StringConstructor | NumberConstructor)[];
+type: (StringConstructor | NumberConstructor | null)[];
 required: false;
 default: string;
 };
@@ -10634,7 +10709,7 @@ onChange?: ((...args: any[]) => any) | undefined;
 }>, {
 type: string;
 id: string;
-modelValue: string | number;
+modelValue: string | number | null;
 inline: boolean;
 disabled: boolean;
 options: string[] | undefined;
@@ -10969,7 +11044,7 @@ required: false;
 default: boolean;
 };
 modelValue: {
-type: (StringConstructor | NumberConstructor)[];
+type: (StringConstructor | NumberConstructor | null)[];
 required: false;
 default: string;
 };
@@ -11067,7 +11142,7 @@ required: false;
 default: boolean;
 };
 modelValue: {
-type: (StringConstructor | NumberConstructor)[];
+type: (StringConstructor | NumberConstructor | null)[];
 required: false;
 default: string;
 };
@@ -11113,7 +11188,7 @@ onChange?: ((...args: any[]) => any) | undefined;
 }>, {
 type: string;
 id: string;
-modelValue: string | number;
+modelValue: string | number | null;
 inline: boolean;
 disabled: boolean;
 options: string[] | undefined;
@@ -11413,11 +11488,12 @@ default: () => string;
 };
 /**
 * The value for the input.
-* If the prop is not set undefined will be used.
+* If the prop is not used or set to undefined
+* or null then the default value will be used.
 * @model
 */
 modelValue: {
-type: StringConstructor;
+type: (StringConstructor | null)[];
 required: false;
 default: undefined;
 };
@@ -11454,11 +11530,12 @@ default: () => string;
 };
 /**
 * The value for the input.
-* If the prop is not set undefined will be used.
+* If the prop is not used or set to undefined
+* or null then the default value will be used.
 * @model
 */
 modelValue: {
-type: StringConstructor;
+type: (StringConstructor | null)[];
 required: false;
 default: undefined;
 };
@@ -11476,7 +11553,7 @@ onChange?: ((...args: any[]) => any) | undefined;
 "onUpdate:modelValue"?: ((...args: any[]) => any) | undefined;
 }>, {
 id: string;
-modelValue: string;
+modelValue: string | null;
 maxLength: number;
 extendedValidation: boolean;
 }, {}, {
@@ -11492,7 +11569,7 @@ required: false;
 default: boolean;
 };
 modelValue: {
-type: (StringConstructor | NumberConstructor)[];
+type: (StringConstructor | NumberConstructor | null)[];
 required: false;
 default: string;
 };
@@ -11590,7 +11667,7 @@ required: false;
 default: boolean;
 };
 modelValue: {
-type: (StringConstructor | NumberConstructor)[];
+type: (StringConstructor | NumberConstructor | null)[];
 required: false;
 default: string;
 };
@@ -11636,7 +11713,7 @@ onChange?: ((...args: any[]) => any) | undefined;
 }>, {
 type: string;
 id: string;
-modelValue: string | number;
+modelValue: string | number | null;
 inline: boolean;
 disabled: boolean;
 options: string[] | undefined;
@@ -11942,7 +12019,7 @@ required: false;
 default: boolean;
 };
 modelValue: {
-type: (StringConstructor | NumberConstructor)[];
+type: (StringConstructor | NumberConstructor | null)[];
 required: false;
 default: string;
 };
@@ -12040,7 +12117,7 @@ required: false;
 default: boolean;
 };
 modelValue: {
-type: (StringConstructor | NumberConstructor)[];
+type: (StringConstructor | NumberConstructor | null)[];
 required: false;
 default: string;
 };
@@ -12086,7 +12163,7 @@ onChange?: ((...args: any[]) => any) | undefined;
 }>, {
 type: string;
 id: string;
-modelValue: string | number;
+modelValue: string | number | null;
 inline: boolean;
 disabled: boolean;
 options: string[] | undefined;
@@ -12401,7 +12478,7 @@ required: false;
 default: boolean;
 };
 modelValue: {
-type: (StringConstructor | NumberConstructor)[];
+type: (StringConstructor | NumberConstructor | null)[];
 required: false;
 default: string;
 };
@@ -12499,7 +12576,7 @@ required: false;
 default: boolean;
 };
 modelValue: {
-type: (StringConstructor | NumberConstructor)[];
+type: (StringConstructor | NumberConstructor | null)[];
 required: false;
 default: string;
 };
@@ -12545,7 +12622,7 @@ onChange?: ((...args: any[]) => any) | undefined;
 }>, {
 type: string;
 id: string;
-modelValue: string | number;
+modelValue: string | number | null;
 inline: boolean;
 disabled: boolean;
 options: string[] | undefined;
@@ -12998,6 +13075,8 @@ id: string;
 disabled: boolean;
 }, {}, {}, {}, string, ComponentProvideOptions, true, {}, any>;
 
+export declare const FResizePane: __VLS_WithTemplateSlots_4<typeof __VLS_component_4, __VLS_TemplateResult_4["slots"]>;
+
 export declare const FSearchTextField: DefineComponent<ExtractPropTypes<    {
 id: {
 type: StringConstructor;
@@ -13005,7 +13084,7 @@ required: false;
 default: () => string;
 };
 modelValue: {
-type: StringConstructor;
+type: (StringConstructor | null)[];
 required: false;
 default: string;
 };
@@ -13035,7 +13114,7 @@ required: false;
 default: () => string;
 };
 modelValue: {
-type: StringConstructor;
+type: (StringConstructor | null)[];
 required: false;
 default: string;
 };
@@ -13055,7 +13134,7 @@ onChange?: ((...args: any[]) => any) | undefined;
 onUpdate?: ((...args: any[]) => any) | undefined;
 }>, {
 id: string;
-modelValue: string;
+modelValue: string | null;
 maxLength: number;
 clearableScreenReaderText: string;
 }, {}, {
@@ -13071,7 +13150,7 @@ required: false;
 default: boolean;
 };
 modelValue: {
-type: (StringConstructor | NumberConstructor)[];
+type: (StringConstructor | NumberConstructor | null)[];
 required: false;
 default: string;
 };
@@ -13169,7 +13248,7 @@ required: false;
 default: boolean;
 };
 modelValue: {
-type: (StringConstructor | NumberConstructor)[];
+type: (StringConstructor | NumberConstructor | null)[];
 required: false;
 default: string;
 };
@@ -13215,7 +13294,7 @@ onChange?: ((...args: any[]) => any) | undefined;
 }>, {
 type: string;
 id: string;
-modelValue: string | number;
+modelValue: string | number | null;
 inline: boolean;
 disabled: boolean;
 options: string[] | undefined;
@@ -14479,11 +14558,12 @@ default: boolean;
 };
 /**
 * The value for the input.
-* If the prop is not set undefined will be used.
+* If the prop is not used or set to undefined
+* or null then the default value will be used.
 * @model
 */
 modelValue: {
-type: (StringConstructor | NumberConstructor)[];
+type: (StringConstructor | NumberConstructor | null)[];
 required: false;
 default: string;
 };
@@ -14639,11 +14719,12 @@ default: boolean;
 };
 /**
 * The value for the input.
-* If the prop is not set undefined will be used.
+* If the prop is not used or set to undefined
+* or null then the default value will be used.
 * @model
 */
 modelValue: {
-type: (StringConstructor | NumberConstructor)[];
+type: (StringConstructor | NumberConstructor | null)[];
 required: false;
 default: string;
 };
@@ -14738,7 +14819,7 @@ onChange?: ((...args: any[]) => any) | undefined;
 }>, {
 type: string;
 id: string;
-modelValue: string | number;
+modelValue: string | number | null;
 inline: boolean;
 disabled: boolean;
 options: string[] | undefined;
@@ -16682,10 +16763,10 @@ rotate: string;
 }, {}, {}, {}, string, ComponentProvideOptions, true, {}, any>;
 }, {}, string, ComponentProvideOptions, true, {}, any>;
 
-export declare const IComboboxDropdown: DefineComponent<__VLS_Props, {}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {
+export declare const IComboboxDropdown: DefineComponent<__VLS_Props_3, {}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {
 close: () => any;
 select: (option: string) => any;
-}, string, PublicProps, Readonly<__VLS_Props> & Readonly<{
+}, string, PublicProps, Readonly<__VLS_Props_3> & Readonly<{
 onClose?: (() => any) | undefined;
 onSelect?: ((option: string) => any) | undefined;
 }>, {}, {}, {}, {}, string, ComponentProvideOptions, false, {
@@ -17180,7 +17261,7 @@ export declare interface IPopupErrorData {
     arrowOffset: number;
 }
 
-export declare const IPopupListbox: __VLS_WithTemplateSlots_3<typeof __VLS_component_3, __VLS_TemplateResult_3["slots"]>;
+export declare const IPopupListbox: __VLS_WithTemplateSlots_5<typeof __VLS_component_5, __VLS_TemplateResult_5["slots"]>;
 
 declare interface IPopupListboxProps {
     isOpen: boolean;
@@ -17514,6 +17595,38 @@ href: string;
  */
 export declare function itemEquals<T extends object, K extends keyof T>(item1: T | undefined, item2: T | undefined, compareAttribute: K): boolean;
 
+/**
+ * @public
+ */
+export declare type LayoutAreaAttachPanel = "none" | "left" | "right" | "top" | "bottom";
+
+/**
+ * @public
+ */
+export declare interface LayoutAreaDefinition {
+    /** Where panels will attach to */
+    attachPanel: LayoutAreaAttachPanel;
+    /** What direction content of the area will appear (mapped to `flex-direction`) */
+    direction: LayoutAreaDirection;
+    /** If the content of the area is scrollable (in direction given by `direction`), default `false`. */
+    scroll?: boolean;
+}
+
+/**
+ * @public
+ */
+export declare type LayoutAreaDirection = "column" | "row";
+
+/**
+ * A definition of a layout for {@link FPageLayout}.
+ *
+ * @public
+ */
+export declare interface LayoutDefinition {
+    name: string;
+    areas: Record<string, LayoutAreaDefinition>;
+}
+
 /**
  * Represents an array of items in a list-based component (FList, FTable, etc).
  *
@@ -17811,6 +17924,13 @@ export declare function refIsVue(value: unknown): value is ComponentPublicInstan
  */
 export declare function refIsVueArray(value: unknown): value is ComponentPublicInstance[];
 
+/**
+ * Register a new layout for usage with {@link FPageLayout}.
+ *
+ * @public
+ */
+export declare function registerLayout<T extends LayoutDefinition>(definition: T): void;
+
 /**
  * @public
  */
@@ -17895,7 +18015,7 @@ export declare const TestPlugin: Plugin_2;
 export declare interface TextFieldSetupProps {
     id: string;
     inline: boolean;
-    modelValue: string | number;
+    modelValue: string | number | null;
     type: string;
     formatter?: FormatFunction<unknown>;
     parser?: ParseFunction<unknown>;
@@ -17964,6 +18084,25 @@ export declare const UNHANDLED_ERROR_EVENT: "unhandled-error";
  */
 export declare type UnknownItem = Record<string, unknown>;
 
+/**
+ * @public
+ */
+export declare interface UseAreaData {
+    /** Name of layout area */
+    readonly area: Readonly<Ref<string | null>>;
+    /** Panel attachment */
+    readonly attachPanel: Readonly<Ref<LayoutAreaAttachPanel | null>>;
+    /** Direction area content flows */
+    readonly direction: Readonly<Ref<LayoutAreaDirection | null>>;
+}
+
+/**
+ * Fetch information about the layout area given element belongs to.
+ *
+ * @public
+ */
+export declare function useAreaData(element: Readonly<ShallowRef<HTMLElement | null | undefined>>): UseAreaData;
+
 /**
  * @public
  */