@evance/evance-ui 1.0.5 → 1.0.6

package/dist/types/EvList.d.ts

@@ -0,0 +1,548 @@
+import { AllowedComponentProps } from 'vue';
+import { ComponentCustomProps } from 'vue';
+import { ComponentOptionsMixin } from 'vue';
+import { DefineComponent } from 'vue';
+import { ExtractPropTypes } from 'vue';
+import { PropType } from 'vue';
+import { StyleValue } from 'vue';
+import { VNodeProps } from 'vue';
+
+declare type __VLS_WithTemplateSlots<T, S> = T & {
+    new (): {
+        $slots: S;
+    };
+};
+
+export declare const EvList: __VLS_WithTemplateSlots<DefineComponent<    {
+height: (StringConstructor | NumberConstructor)[];
+maxHeight: (StringConstructor | NumberConstructor)[];
+maxWidth: (StringConstructor | NumberConstructor)[];
+minHeight: (StringConstructor | NumberConstructor)[];
+minWidth: (StringConstructor | NumberConstructor)[];
+width: (StringConstructor | NumberConstructor)[];
+class: PropType<any>;
+style: {
+type: PropType<StyleValue>;
+default: any;
+};
+openStrategy: PropType<OpenStrategy | OpenStrategyRef>;
+opened: PropType<readonly unknown[]>;
+selectStrategy: {
+type: PropType<string | SelectStrategyFn>;
+default: string | SelectStrategyFn;
+};
+selected: PropType<readonly unknown[]>;
+required: BooleanConstructor;
+items: {
+type: PropType<any[]>;
+default: () => any[];
+};
+itemTitle: {
+type: PropType<ListItemKey>;
+default: string;
+};
+itemValue: {
+type: PropType<ListItemKey>;
+default: string;
+};
+itemChildren: {
+type: PropType<ListItemKey>;
+default: string;
+};
+itemProps: {
+type: PropType<ListItemKey>;
+default: string;
+};
+returnObject: BooleanConstructor;
+valueComparator: {
+type: PropType<isDeepEqual>;
+default: isDeepEqual;
+};
+disabled: BooleanConstructor;
+tag: {
+type: StringConstructor;
+default: string;
+};
+itemType: {
+type: StringConstructor;
+default: string;
+};
+}, {
+focus: typeof focus_2;
+select: (id: unknown, value: boolean, event?: Event) => void;
+}, unknown, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {
+"click:select": (...args: any[]) => void;
+"update:selected": (...args: any[]) => void;
+}, string, VNodeProps & AllowedComponentProps & ComponentCustomProps, Readonly<ExtractPropTypes<    {
+height: (StringConstructor | NumberConstructor)[];
+maxHeight: (StringConstructor | NumberConstructor)[];
+maxWidth: (StringConstructor | NumberConstructor)[];
+minHeight: (StringConstructor | NumberConstructor)[];
+minWidth: (StringConstructor | NumberConstructor)[];
+width: (StringConstructor | NumberConstructor)[];
+class: PropType<any>;
+style: {
+type: PropType<StyleValue>;
+default: any;
+};
+openStrategy: PropType<OpenStrategy | OpenStrategyRef>;
+opened: PropType<readonly unknown[]>;
+selectStrategy: {
+type: PropType<string | SelectStrategyFn>;
+default: string | SelectStrategyFn;
+};
+selected: PropType<readonly unknown[]>;
+required: BooleanConstructor;
+items: {
+type: PropType<any[]>;
+default: () => any[];
+};
+itemTitle: {
+type: PropType<ListItemKey>;
+default: string;
+};
+itemValue: {
+type: PropType<ListItemKey>;
+default: string;
+};
+itemChildren: {
+type: PropType<ListItemKey>;
+default: string;
+};
+itemProps: {
+type: PropType<ListItemKey>;
+default: string;
+};
+returnObject: BooleanConstructor;
+valueComparator: {
+type: PropType<isDeepEqual>;
+default: isDeepEqual;
+};
+disabled: BooleanConstructor;
+tag: {
+type: StringConstructor;
+default: string;
+};
+itemType: {
+type: StringConstructor;
+default: string;
+};
+}>> & {
+"onUpdate:selected"?: (...args: any[]) => any;
+"onClick:select"?: (...args: any[]) => any;
+}, {
+required: boolean;
+disabled: boolean;
+style: StyleValue;
+tag: string;
+items: any[];
+valueComparator: isDeepEqual;
+itemValue: ListItemKey;
+returnObject: boolean;
+selectStrategy: string | SelectStrategyFn;
+itemTitle: ListItemKey;
+itemChildren: ListItemKey;
+itemProps: ListItemKey;
+itemType: string;
+}, {}>, {
+    default?(_: {}): any;
+}>;
+
+/**
+ * # Set Focus
+ * @param position
+ */
+declare function focus_2(position?: FocusPosition): void;
+
+/**
+ * # Focus Position
+ */
+declare type FocusPosition = "next" | "previous" | "first" | "last";
+
+/**
+ * # Getter Property Key
+ *
+ * Defines where to look for Property information within getter functions.
+ *
+ * For example: an object might have a `title` property.
+ * So a property key may represent either an array index, or an object property.
+ *
+ * - `boolean`, `null`, `undefined` - Ignored
+ * - `string` - Property name, or use Object path notation.
+ * - `array` of strings or numbers represent nested lookup - each array element represents a key in the hierarchy
+ * - A callback function accepting `item` and `fallback` arguments.
+ */
+declare type GetterPropertyKey<T = Record<string, any>> = boolean | null | undefined | string | (string | number)[] | ((item: T, fallback?: any) => any);
+
+/**
+ * # Is Deep Equal?
+ *
+ * I could have used the `deep-equal` npm package, but decided to keep things as light-weight
+ * as possible and this suits our needs for now:
+ *
+ * @link https://www.npmjs.com/package/deep-equal
+ *
+ * @param a
+ * @param b
+ */
+declare function isDeepEqual(a: any, b: any): boolean;
+
+/**
+ * # List Item
+ */
+export declare interface ListItem extends ListItem_2 {
+    type?: ListItemType;
+}
+
+/**
+ * # List Item
+ */
+declare interface ListItem_2<T = any> {
+    key: number;
+    title: string;
+    value: any;
+    props: {
+        [key: string]: any;
+        title: string;
+        value: any;
+    };
+    children?: ListItem_2<T>[];
+    raw: T;
+}
+
+/**
+ * # List Item Key
+ *
+ * Defines where to look for item information.
+ *
+ * For example: each Item might have a `title` property.
+ * So an Item key may represent either an array index, or an object property.
+ *
+ * - `boolean` - Ignored
+ * - `string` - Property name, or use Object path notation.
+ * - `array` of strings or numbers represent nested lookup - each array element represents a key in the hierarchy
+ */
+declare type ListItemKey = GetterPropertyKey;
+
+/**
+ * # List Item Props
+ */
+export declare interface ListItemProps extends ListItemsProps {
+    itemType: string;
+}
+
+/**
+ * # List Items Props
+ *
+ * - `items` - the array of items to render within a list.
+ * - `item-title` - the title property/key to use as the title in each list item.
+ * - `item-value` - the value property/key to use for selection per list item.
+ * - `item-props` - the props to assign to each list item.
+ * - `return-object` - return the full item object on selection if `true`, or the `item-value` if `false`.
+ */
+declare interface ListItemsProps {
+    items: any[];
+    itemTitle: ListItemKey;
+    itemValue: ListItemKey;
+    itemChildren: ListItemKey;
+    itemProps: ListItemKey;
+    returnObject: boolean;
+    valueComparator: typeof isDeepEqual;
+}
+
+/**
+ * # List Item Types
+ */
+export declare type ListItemType = "item" | "subheader" | "divider";
+
+/**
+ * # Make EvListChildren Props
+ */
+export declare const makeEvListChildrenProps: <Defaults extends {
+    items?: unknown;
+} = {}>(defaults?: Defaults) => {
+    items: unknown extends Defaults["items"] ? PropType<readonly ListItem[]> : {
+        type: PropType<unknown extends Defaults["items"] ? readonly ListItem[] : readonly ListItem[] | Defaults["items"]>;
+        default: unknown extends Defaults["items"] ? readonly ListItem[] : readonly ListItem[] | Defaults["items"];
+    };
+};
+
+/**
+ * # Make EvList Props
+ */
+export declare const makeEvListProps: <Defaults extends {
+    height?: unknown;
+    maxHeight?: unknown;
+    maxWidth?: unknown;
+    minHeight?: unknown;
+    minWidth?: unknown;
+    width?: unknown;
+    class?: unknown;
+    style?: unknown;
+    openStrategy?: unknown;
+    opened?: unknown;
+    selectStrategy?: unknown;
+    selected?: unknown;
+    required?: unknown;
+    items?: unknown;
+    itemTitle?: unknown;
+    itemValue?: unknown;
+    itemChildren?: unknown;
+    itemProps?: unknown;
+    returnObject?: unknown;
+    valueComparator?: unknown;
+    disabled?: unknown;
+    tag?: unknown;
+    itemType?: unknown;
+} = {}>(defaults?: Defaults) => {
+    height: unknown extends Defaults["height"] ? (StringConstructor | NumberConstructor)[] : {
+        type: PropType<unknown extends Defaults["height"] ? string | number : NonNullable<string | number> | Defaults["height"]>;
+        default: unknown extends Defaults["height"] ? string | number : NonNullable<string | number> | Defaults["height"];
+    };
+    maxHeight: unknown extends Defaults["maxHeight"] ? (StringConstructor | NumberConstructor)[] : {
+        type: PropType<unknown extends Defaults["maxHeight"] ? string | number : NonNullable<string | number> | Defaults["maxHeight"]>;
+        default: unknown extends Defaults["maxHeight"] ? string | number : NonNullable<string | number> | Defaults["maxHeight"];
+    };
+    maxWidth: unknown extends Defaults["maxWidth"] ? (StringConstructor | NumberConstructor)[] : {
+        type: PropType<unknown extends Defaults["maxWidth"] ? string | number : NonNullable<string | number> | Defaults["maxWidth"]>;
+        default: unknown extends Defaults["maxWidth"] ? string | number : NonNullable<string | number> | Defaults["maxWidth"];
+    };
+    minHeight: unknown extends Defaults["minHeight"] ? (StringConstructor | NumberConstructor)[] : {
+        type: PropType<unknown extends Defaults["minHeight"] ? string | number : NonNullable<string | number> | Defaults["minHeight"]>;
+        default: unknown extends Defaults["minHeight"] ? string | number : NonNullable<string | number> | Defaults["minHeight"];
+    };
+    minWidth: unknown extends Defaults["minWidth"] ? (StringConstructor | NumberConstructor)[] : {
+        type: PropType<unknown extends Defaults["minWidth"] ? string | number : NonNullable<string | number> | Defaults["minWidth"]>;
+        default: unknown extends Defaults["minWidth"] ? string | number : NonNullable<string | number> | Defaults["minWidth"];
+    };
+    width: unknown extends Defaults["width"] ? (StringConstructor | NumberConstructor)[] : {
+        type: PropType<unknown extends Defaults["width"] ? string | number : NonNullable<string | number> | Defaults["width"]>;
+        default: unknown extends Defaults["width"] ? string | number : NonNullable<string | number> | Defaults["width"];
+    };
+    class: unknown extends Defaults["class"] ? PropType<any> : {
+        type: PropType<unknown extends Defaults["class"] ? any : any>;
+        default: unknown extends Defaults["class"] ? any : any;
+    };
+    style: unknown extends Defaults["style"] ? {
+        type: PropType<StyleValue>;
+        default: any;
+    } : Omit<{
+        type: PropType<StyleValue>;
+        default: any;
+    }, "type" | "default"> & {
+        type: PropType<unknown extends Defaults["style"] ? StyleValue : NonNullable<StyleValue> | Defaults["style"]>;
+        default: unknown extends Defaults["style"] ? StyleValue : NonNullable<StyleValue> | Defaults["style"];
+    };
+    openStrategy: unknown extends Defaults["openStrategy"] ? PropType<OpenStrategy | OpenStrategyRef> : {
+        type: PropType<unknown extends Defaults["openStrategy"] ? OpenStrategy | OpenStrategyRef : NonNullable<OpenStrategy | OpenStrategyRef> | Defaults["openStrategy"]>;
+        default: unknown extends Defaults["openStrategy"] ? OpenStrategy | OpenStrategyRef : NonNullable<OpenStrategy | OpenStrategyRef> | Defaults["openStrategy"];
+    };
+    opened: unknown extends Defaults["opened"] ? PropType<readonly unknown[]> : {
+        type: PropType<unknown extends Defaults["opened"] ? readonly unknown[] : readonly unknown[] | Defaults["opened"]>;
+        default: unknown extends Defaults["opened"] ? readonly unknown[] : readonly unknown[] | Defaults["opened"];
+    };
+    selectStrategy: unknown extends Defaults["selectStrategy"] ? {
+        type: PropType<string | SelectStrategyFn>;
+        default: string | SelectStrategyFn;
+    } : Omit<{
+        type: PropType<string | SelectStrategyFn>;
+        default: string | SelectStrategyFn;
+    }, "type" | "default"> & {
+        type: PropType<unknown extends Defaults["selectStrategy"] ? string | SelectStrategyFn : Defaults["selectStrategy"] | NonNullable<string | SelectStrategyFn>>;
+        default: unknown extends Defaults["selectStrategy"] ? string | SelectStrategyFn : Defaults["selectStrategy"] | NonNullable<string | SelectStrategyFn>;
+    };
+    selected: unknown extends Defaults["selected"] ? PropType<readonly unknown[]> : {
+        type: PropType<unknown extends Defaults["selected"] ? readonly unknown[] : readonly unknown[] | Defaults["selected"]>;
+        default: unknown extends Defaults["selected"] ? readonly unknown[] : readonly unknown[] | Defaults["selected"];
+    };
+    required: unknown extends Defaults["required"] ? BooleanConstructor : {
+        type: PropType<unknown extends Defaults["required"] ? boolean : boolean | Defaults["required"]>;
+        default: unknown extends Defaults["required"] ? boolean : boolean | Defaults["required"];
+    };
+    items: unknown extends Defaults["items"] ? {
+        type: PropType<any[]>;
+        default: () => any[];
+    } : Omit<{
+        type: PropType<any[]>;
+        default: () => any[];
+    }, "type" | "default"> & {
+        type: PropType<unknown extends Defaults["items"] ? any[] : any[] | Defaults["items"]>;
+        default: unknown extends Defaults["items"] ? any[] : any[] | Defaults["items"];
+    };
+    itemTitle: unknown extends Defaults["itemTitle"] ? {
+        type: PropType<ListItemKey>;
+        default: string;
+    } : Omit<{
+        type: PropType<ListItemKey>;
+        default: string;
+    }, "type" | "default"> & {
+        type: PropType<unknown extends Defaults["itemTitle"] ? ListItemKey : NonNullable<ListItemKey> | Defaults["itemTitle"]>;
+        default: unknown extends Defaults["itemTitle"] ? ListItemKey : NonNullable<ListItemKey> | Defaults["itemTitle"];
+    };
+    itemValue: unknown extends Defaults["itemValue"] ? {
+        type: PropType<ListItemKey>;
+        default: string;
+    } : Omit<{
+        type: PropType<ListItemKey>;
+        default: string;
+    }, "type" | "default"> & {
+        type: PropType<unknown extends Defaults["itemValue"] ? ListItemKey : NonNullable<ListItemKey> | Defaults["itemValue"]>;
+        default: unknown extends Defaults["itemValue"] ? ListItemKey : NonNullable<ListItemKey> | Defaults["itemValue"];
+    };
+    itemChildren: unknown extends Defaults["itemChildren"] ? {
+        type: PropType<ListItemKey>;
+        default: string;
+    } : Omit<{
+        type: PropType<ListItemKey>;
+        default: string;
+    }, "type" | "default"> & {
+        type: PropType<unknown extends Defaults["itemChildren"] ? ListItemKey : NonNullable<ListItemKey> | Defaults["itemChildren"]>;
+        default: unknown extends Defaults["itemChildren"] ? ListItemKey : NonNullable<ListItemKey> | Defaults["itemChildren"];
+    };
+    itemProps: unknown extends Defaults["itemProps"] ? {
+        type: PropType<ListItemKey>;
+        default: string;
+    } : Omit<{
+        type: PropType<ListItemKey>;
+        default: string;
+    }, "type" | "default"> & {
+        type: PropType<unknown extends Defaults["itemProps"] ? ListItemKey : NonNullable<ListItemKey> | Defaults["itemProps"]>;
+        default: unknown extends Defaults["itemProps"] ? ListItemKey : NonNullable<ListItemKey> | Defaults["itemProps"];
+    };
+    returnObject: unknown extends Defaults["returnObject"] ? BooleanConstructor : {
+        type: PropType<unknown extends Defaults["returnObject"] ? boolean : boolean | Defaults["returnObject"]>;
+        default: unknown extends Defaults["returnObject"] ? boolean : boolean | Defaults["returnObject"];
+    };
+    valueComparator: unknown extends Defaults["valueComparator"] ? {
+        type: PropType<isDeepEqual>;
+        default: isDeepEqual;
+    } : Omit<{
+        type: PropType<isDeepEqual>;
+        default: isDeepEqual;
+    }, "type" | "default"> & {
+        type: PropType<unknown extends Defaults["valueComparator"] ? isDeepEqual : isDeepEqual | Defaults["valueComparator"]>;
+        default: unknown extends Defaults["valueComparator"] ? isDeepEqual : isDeepEqual | Defaults["valueComparator"];
+    };
+    disabled: unknown extends Defaults["disabled"] ? BooleanConstructor : {
+        type: PropType<unknown extends Defaults["disabled"] ? boolean : boolean | Defaults["disabled"]>;
+        default: unknown extends Defaults["disabled"] ? boolean : boolean | Defaults["disabled"];
+    };
+    tag: unknown extends Defaults["tag"] ? {
+        type: StringConstructor;
+        default: string;
+    } : Omit<{
+        type: StringConstructor;
+        default: string;
+    }, "type" | "default"> & {
+        type: PropType<unknown extends Defaults["tag"] ? string : string | Defaults["tag"]>;
+        default: unknown extends Defaults["tag"] ? string : string | Defaults["tag"];
+    };
+    itemType: unknown extends Defaults["itemType"] ? {
+        type: StringConstructor;
+        default: string;
+    } : Omit<{
+        type: StringConstructor;
+        default: string;
+    }, "type" | "default"> & {
+        type: PropType<unknown extends Defaults["itemType"] ? string : string | Defaults["itemType"]>;
+        default: unknown extends Defaults["itemType"] ? string : string | Defaults["itemType"];
+    };
+};
+
+/**
+ * # Open Select Strategy Data
+ */
+declare interface OpenSelectStrategyData extends OpenStrategyData {
+    selected: Map<unknown, Selected>;
+}
+
+/**
+ * # Open Select Strategy Function
+ */
+declare type OpenSelectStrategyFn = (data: OpenSelectStrategyData) => Set<unknown> | null;
+
+/**
+ * # Open Strategy
+ */
+declare type OpenStrategy = {
+    open: OpenStrategyFn;
+    select: OpenSelectStrategyFn;
+};
+
+/**
+ * # Open Strategy Data
+ */
+declare interface OpenStrategyData {
+    id: unknown;
+    value: boolean;
+    opened: Set<unknown>;
+    children: Map<unknown, unknown[]>;
+    parents: Map<unknown, unknown>;
+    event?: Event;
+}
+
+/**
+ * # Open Strategy Function
+ */
+declare type OpenStrategyFn = (data: OpenStrategyData) => Set<unknown>;
+
+/**
+ * # Open Strategy Reference
+ * Recognised open strategy strings.
+ */
+declare type OpenStrategyRef = "single" | "multiple" | "list";
+
+/**
+ * # Selected
+ */
+declare type Selected = "on" | "off" | "indeterminate";
+
+/**
+ * # Select Strategy Data
+ */
+declare interface SelectStrategyData {
+    id: unknown;
+    value: boolean;
+    selected: Map<unknown, Selected>;
+    children: Map<unknown, unknown[]>;
+    parents: Map<unknown, unknown>;
+    event?: Event;
+}
+
+/**
+ * # Select Strategy Function
+ */
+declare type SelectStrategyFn = (data: SelectStrategyData) => Map<unknown, Selected>;
+
+export { }
+
+
+export declare namespace toDisplayStateKey {
+    var cache: Map<string, string>;
+}
+
+
+export declare namespace toDisplayRuleKebab {
+    var cache: Map<string, string>;
+}
+
+
+export declare namespace getNextId {
+    var reset: () => void;
+}
+
+
+export declare namespace spaceSeparatedValues {
+    var cache: Map<string, string[]>;
+}
+
+
+export declare namespace toKebabCase {
+    var cache: Map<string, string>;
+}
+
+
+export declare namespace toCamelCase {
+    var cache: Map<string, string>;
+}
+