@evance/evance-ui 1.0.7 → 1.0.8

package/dist/types/EvButton.d.ts

@@ -0,0 +1,468 @@
+import { AllowedComponentProps } from 'vue';
+import { ComponentCustomProps } from 'vue';
+import { ComponentInternalInstance } from 'vue';
+import { ComponentOptionsMixin } from 'vue';
+import { ComputedRef } from 'vue';
+import { DefineComponent } from 'vue';
+import { ExtractPropTypes } from 'vue';
+import { InjectionKey } from 'vue';
+import { PropType } from 'vue';
+import { Ref } from 'vue';
+import { RouteLocationRaw } from 'vue-router';
+import { StyleValue } from 'vue';
+import { VNodeProps } from 'vue';
+
+declare type __VLS_WithTemplateSlots<T, S> = T & {
+    new (): {
+        $slots: S;
+    };
+};
+
+/**
+ * # Appearance
+ *
+ * Default appearance keys for
+ *
+ */
+declare const Appearance: {
+    readonly default: "default";
+    readonly danger: "danger";
+    readonly information: "information";
+    readonly notice: "notice";
+    readonly primary: "primary";
+    readonly success: "success";
+    readonly warning: "warning";
+};
+
+declare type AppearanceProp = (typeof Appearance)[keyof typeof Appearance];
+
+/**
+ * ## Button Appearance
+ */
+export declare type ButtonAppearanceProp = AppearanceProp | "inverse";
+
+export declare type ButtonVariantProp = VariantProp | "link";
+
+export declare const EvButton: __VLS_WithTemplateSlots<DefineComponent<    {
+value: any;
+disabled: BooleanConstructor;
+selectedClass: StringConstructor;
+selectedAppearance: StringConstructor;
+selectedVariant: StringConstructor;
+href: StringConstructor;
+replace: BooleanConstructor;
+to: PropType<RouteLocationRaw>;
+exact: BooleanConstructor;
+class: PropType<any>;
+style: {
+type: PropType<StyleValue>;
+default: any;
+};
+active: {
+type: BooleanConstructor;
+default: any;
+};
+symbol: {
+type: any;
+default: InjectionKey<GroupProvide>;
+};
+appearance: {
+type: PropType<ButtonAppearanceProp>;
+default: "default";
+};
+icon: PropType<boolean | IconValue>;
+iconStart: PropType<IconValue>;
+iconEnd: PropType<IconValue>;
+rounded: BooleanConstructor;
+size: PropType<InputSizeProp>;
+fullWidth: BooleanConstructor;
+selectedIcon: PropType<IconValue>;
+selectedIconStart: PropType<IconValue>;
+selectedIconEnd: PropType<IconValue>;
+text: StringConstructor;
+loading: BooleanConstructor;
+variant: {
+type: PropType<ButtonVariantProp>;
+default: string;
+};
+}, {
+group: GroupItemProvide;
+}, unknown, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {
+"group:selected": (...args: any[]) => void;
+}, string, VNodeProps & AllowedComponentProps & ComponentCustomProps, Readonly<ExtractPropTypes<    {
+value: any;
+disabled: BooleanConstructor;
+selectedClass: StringConstructor;
+selectedAppearance: StringConstructor;
+selectedVariant: StringConstructor;
+href: StringConstructor;
+replace: BooleanConstructor;
+to: PropType<RouteLocationRaw>;
+exact: BooleanConstructor;
+class: PropType<any>;
+style: {
+type: PropType<StyleValue>;
+default: any;
+};
+active: {
+type: BooleanConstructor;
+default: any;
+};
+symbol: {
+type: any;
+default: InjectionKey<GroupProvide>;
+};
+appearance: {
+type: PropType<ButtonAppearanceProp>;
+default: "default";
+};
+icon: PropType<boolean | IconValue>;
+iconStart: PropType<IconValue>;
+iconEnd: PropType<IconValue>;
+rounded: BooleanConstructor;
+size: PropType<InputSizeProp>;
+fullWidth: BooleanConstructor;
+selectedIcon: PropType<IconValue>;
+selectedIconStart: PropType<IconValue>;
+selectedIconEnd: PropType<IconValue>;
+text: StringConstructor;
+loading: BooleanConstructor;
+variant: {
+type: PropType<ButtonVariantProp>;
+default: string;
+};
+}>> & {
+"onGroup:selected"?: (...args: any[]) => any;
+}, {
+symbol: any;
+active: boolean;
+replace: boolean;
+value: any;
+disabled: boolean;
+appearance: ButtonAppearanceProp;
+variant: ButtonVariantProp;
+style: StyleValue;
+rounded: boolean;
+exact: boolean;
+fullWidth: boolean;
+loading: boolean;
+}, {}>, Readonly<{
+    default(): never;
+    icon(): never;
+    "icon-end"(): never;
+    "icon-start"(): never;
+    prefix(): never;
+    suffix(): never;
+    additional(): never;
+}>>;
+
+/**
+ * # EvButtonProps
+ */
+export declare interface EvButtonProps extends RouterLinkOrHrefProps {
+    appearance?: ButtonAppearanceProp;
+    disabled?: boolean;
+    icon?: IconValue | boolean;
+    iconStart?: IconValue;
+    iconEnd?: IconValue;
+    rounded?: boolean;
+    size?: InputSizeProp;
+    fullWidth?: boolean;
+    text?: string;
+    loading?: boolean;
+    onClick?: () => void;
+    variant?: ButtonVariantProp;
+}
+
+/**
+ * # GroupItem
+ */
+declare interface GroupItem {
+    id: number;
+    value: Ref<unknown>;
+    disabled: Ref<boolean | undefined>;
+}
+
+/**
+ * # GroupItemProvide
+ */
+declare interface GroupItemProvide {
+    id: number;
+    isSelected: Ref<boolean>;
+    toggle: () => void;
+    select: (value: boolean) => void;
+    selectedClass: Ref<(string | undefined)[] | false>;
+    selectedAppearance: Ref<string | undefined>;
+    selectedVariant: Ref<string | undefined>;
+    value: Ref<unknown>;
+    disabled: Ref<boolean | undefined>;
+    group: GroupProvide;
+}
+
+/**
+ * # GroupProvide
+ */
+declare interface GroupProvide {
+    register: (item: GroupItem, cmp: ComponentInternalInstance) => void;
+    unregister: (id: number) => void;
+    select: (id: number, value: boolean) => void;
+    selected: Ref<Readonly<number[]>>;
+    isSelected: (id: number) => boolean;
+    previous: () => void;
+    next: () => void;
+    selectedClass: Ref<string | undefined>;
+    selectedAppearance: Ref<string | undefined>;
+    selectedVariant: Ref<string | undefined>;
+    items: ComputedRef<{
+        id: number;
+        value: unknown;
+        disabled: boolean | undefined;
+    }[]>;
+    disabled: Ref<boolean | undefined>;
+    getItemIndex: (value: unknown) => number;
+}
+
+declare type IconValue = string | (string | [path: string, opacity: number])[];
+
+/**
+ * # Input Sizes
+ */
+declare const InputSize: {
+    readonly default: "medium";
+    readonly xSmall: "x-small";
+    readonly small: "small";
+    readonly medium: "medium";
+    readonly large: "large";
+    readonly xLarge: "x-large";
+};
+
+declare type InputSizeProp = (typeof InputSize)[keyof typeof InputSize];
+
+/**
+ * # EvButton Props
+ */
+export declare const makeEvButtonProps: <Defaults extends {
+    value?: unknown;
+    disabled?: unknown;
+    selectedClass?: unknown;
+    selectedAppearance?: unknown;
+    selectedVariant?: unknown;
+    href?: unknown;
+    replace?: unknown;
+    to?: unknown;
+    exact?: unknown;
+    class?: unknown;
+    style?: unknown;
+    active?: unknown;
+    symbol?: unknown;
+    appearance?: unknown;
+    icon?: unknown;
+    iconStart?: unknown;
+    iconEnd?: unknown;
+    rounded?: unknown;
+    size?: unknown;
+    fullWidth?: unknown;
+    selectedIcon?: unknown;
+    selectedIconStart?: unknown;
+    selectedIconEnd?: unknown;
+    text?: unknown;
+    loading?: unknown;
+    variant?: unknown;
+} = {}>(defaults?: Defaults) => {
+    value: unknown extends Defaults["value"] ? any : (Omit<any, "type" | "default"> & {
+        type: PropType<unknown extends Defaults["value"] ? any : any>;
+        default: unknown extends Defaults["value"] ? any : any;
+    }) | {
+        type: PropType<unknown extends Defaults["value"] ? any : any>;
+        default: unknown extends Defaults["value"] ? any : any;
+    };
+    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"];
+    };
+    selectedClass: unknown extends Defaults["selectedClass"] ? StringConstructor : {
+        type: PropType<unknown extends Defaults["selectedClass"] ? string : string | Defaults["selectedClass"]>;
+        default: unknown extends Defaults["selectedClass"] ? string : string | Defaults["selectedClass"];
+    };
+    selectedAppearance: unknown extends Defaults["selectedAppearance"] ? StringConstructor : {
+        type: PropType<unknown extends Defaults["selectedAppearance"] ? string : string | Defaults["selectedAppearance"]>;
+        default: unknown extends Defaults["selectedAppearance"] ? string : string | Defaults["selectedAppearance"];
+    };
+    selectedVariant: unknown extends Defaults["selectedVariant"] ? StringConstructor : {
+        type: PropType<unknown extends Defaults["selectedVariant"] ? string : string | Defaults["selectedVariant"]>;
+        default: unknown extends Defaults["selectedVariant"] ? string : string | Defaults["selectedVariant"];
+    };
+    href: unknown extends Defaults["href"] ? StringConstructor : {
+        type: PropType<unknown extends Defaults["href"] ? string : string | Defaults["href"]>;
+        default: unknown extends Defaults["href"] ? string : string | Defaults["href"];
+    };
+    replace: unknown extends Defaults["replace"] ? BooleanConstructor : {
+        type: PropType<unknown extends Defaults["replace"] ? boolean : boolean | Defaults["replace"]>;
+        default: unknown extends Defaults["replace"] ? boolean : boolean | Defaults["replace"];
+    };
+    to: unknown extends Defaults["to"] ? PropType<RouteLocationRaw> : {
+        type: PropType<unknown extends Defaults["to"] ? unknown : {} | Defaults["to"]>;
+        default: unknown extends Defaults["to"] ? unknown : {} | Defaults["to"];
+    };
+    exact: unknown extends Defaults["exact"] ? BooleanConstructor : {
+        type: PropType<unknown extends Defaults["exact"] ? boolean : boolean | Defaults["exact"]>;
+        default: unknown extends Defaults["exact"] ? boolean : boolean | Defaults["exact"];
+    };
+    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"];
+    };
+    active: unknown extends Defaults["active"] ? {
+        type: BooleanConstructor;
+        default: any;
+    } : Omit<{
+        type: BooleanConstructor;
+        default: any;
+    }, "type" | "default"> & {
+        type: PropType<unknown extends Defaults["active"] ? boolean : boolean | Defaults["active"]>;
+        default: unknown extends Defaults["active"] ? boolean : boolean | Defaults["active"];
+    };
+    symbol: unknown extends Defaults["symbol"] ? {
+        type: any;
+        default: InjectionKey<GroupProvide>;
+    } : Omit<{
+        type: any;
+        default: InjectionKey<GroupProvide>;
+    }, "type" | "default"> & {
+        type: PropType<unknown extends Defaults["symbol"] ? any : any>;
+        default: unknown extends Defaults["symbol"] ? any : any;
+    };
+    appearance: unknown extends Defaults["appearance"] ? {
+        type: PropType<ButtonAppearanceProp>;
+        default: "default";
+    } : Omit<{
+        type: PropType<ButtonAppearanceProp>;
+        default: "default";
+    }, "type" | "default"> & {
+        type: PropType<unknown extends Defaults["appearance"] ? ButtonAppearanceProp : NonNullable<ButtonAppearanceProp> | Defaults["appearance"]>;
+        default: unknown extends Defaults["appearance"] ? ButtonAppearanceProp : NonNullable<ButtonAppearanceProp> | Defaults["appearance"];
+    };
+    icon: unknown extends Defaults["icon"] ? PropType<boolean | IconValue> : {
+        type: PropType<unknown extends Defaults["icon"] ? boolean | IconValue : Defaults["icon"] | NonNullable<boolean | IconValue>>;
+        default: unknown extends Defaults["icon"] ? boolean | IconValue : Defaults["icon"] | NonNullable<boolean | IconValue>;
+    };
+    iconStart: unknown extends Defaults["iconStart"] ? PropType<IconValue> : {
+        type: PropType<unknown extends Defaults["iconStart"] ? IconValue : NonNullable<IconValue> | Defaults["iconStart"]>;
+        default: unknown extends Defaults["iconStart"] ? IconValue : NonNullable<IconValue> | Defaults["iconStart"];
+    };
+    iconEnd: unknown extends Defaults["iconEnd"] ? PropType<IconValue> : {
+        type: PropType<unknown extends Defaults["iconEnd"] ? IconValue : NonNullable<IconValue> | Defaults["iconEnd"]>;
+        default: unknown extends Defaults["iconEnd"] ? IconValue : NonNullable<IconValue> | Defaults["iconEnd"];
+    };
+    rounded: unknown extends Defaults["rounded"] ? BooleanConstructor : {
+        type: PropType<unknown extends Defaults["rounded"] ? boolean : boolean | Defaults["rounded"]>;
+        default: unknown extends Defaults["rounded"] ? boolean : boolean | Defaults["rounded"];
+    };
+    size: unknown extends Defaults["size"] ? PropType<InputSizeProp> : {
+        type: PropType<unknown extends Defaults["size"] ? InputSizeProp : NonNullable<InputSizeProp> | Defaults["size"]>;
+        default: unknown extends Defaults["size"] ? InputSizeProp : NonNullable<InputSizeProp> | Defaults["size"];
+    };
+    fullWidth: unknown extends Defaults["fullWidth"] ? BooleanConstructor : {
+        type: PropType<unknown extends Defaults["fullWidth"] ? boolean : boolean | Defaults["fullWidth"]>;
+        default: unknown extends Defaults["fullWidth"] ? boolean : boolean | Defaults["fullWidth"];
+    };
+    selectedIcon: unknown extends Defaults["selectedIcon"] ? PropType<IconValue> : {
+        type: PropType<unknown extends Defaults["selectedIcon"] ? IconValue : NonNullable<IconValue> | Defaults["selectedIcon"]>;
+        default: unknown extends Defaults["selectedIcon"] ? IconValue : NonNullable<IconValue> | Defaults["selectedIcon"];
+    };
+    selectedIconStart: unknown extends Defaults["selectedIconStart"] ? PropType<IconValue> : {
+        type: PropType<unknown extends Defaults["selectedIconStart"] ? IconValue : NonNullable<IconValue> | Defaults["selectedIconStart"]>;
+        default: unknown extends Defaults["selectedIconStart"] ? IconValue : NonNullable<IconValue> | Defaults["selectedIconStart"];
+    };
+    selectedIconEnd: unknown extends Defaults["selectedIconEnd"] ? PropType<IconValue> : {
+        type: PropType<unknown extends Defaults["selectedIconEnd"] ? IconValue : NonNullable<IconValue> | Defaults["selectedIconEnd"]>;
+        default: unknown extends Defaults["selectedIconEnd"] ? IconValue : NonNullable<IconValue> | Defaults["selectedIconEnd"];
+    };
+    text: unknown extends Defaults["text"] ? StringConstructor : {
+        type: PropType<unknown extends Defaults["text"] ? string : string | Defaults["text"]>;
+        default: unknown extends Defaults["text"] ? string : string | Defaults["text"];
+    };
+    loading: unknown extends Defaults["loading"] ? BooleanConstructor : {
+        type: PropType<unknown extends Defaults["loading"] ? boolean : boolean | Defaults["loading"]>;
+        default: unknown extends Defaults["loading"] ? boolean : boolean | Defaults["loading"];
+    };
+    variant: unknown extends Defaults["variant"] ? {
+        type: PropType<ButtonVariantProp>;
+        default: string;
+    } : Omit<{
+        type: PropType<ButtonVariantProp>;
+        default: string;
+    }, "type" | "default"> & {
+        type: PropType<unknown extends Defaults["variant"] ? ButtonVariantProp : NonNullable<ButtonVariantProp> | Defaults["variant"]>;
+        default: unknown extends Defaults["variant"] ? ButtonVariantProp : NonNullable<ButtonVariantProp> | Defaults["variant"];
+    };
+};
+
+/**
+ * # RouterLink or Href Props
+ *
+ * We need to be able to accommodate `<a href="">` links
+ * as well as `<router-link to="...">` links.
+ *
+ * This is an important distinction in Evance since we use both.
+ *
+ */
+declare interface RouterLinkOrHrefProps {
+    href?: string;
+    replace?: boolean;
+    to?: RouteLocationRaw;
+    exact?: boolean;
+}
+
+declare const Variant: {
+    readonly default: "default";
+    readonly bold: "bold";
+    readonly outlined: "outlined";
+    readonly subtle: "subtle";
+    readonly tonal: "tonal";
+};
+
+declare type VariantProp = (typeof Variant)[keyof typeof Variant];
+
+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>;
+}
+