@evance/evance-ui 1.0.7 → 1.0.8

package/dist/types/EvCard.d.ts

@@ -0,0 +1,644 @@
+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 { RouteLocationRaw } from 'vue-router';
+import { StyleValue } from 'vue';
+import { VNodeProps } from 'vue';
+
+declare type __VLS_WithTemplateSlots<T, S> = T & {
+    new (): {
+        $slots: S;
+    };
+};
+
+declare type __VLS_WithTemplateSlots_2<T, S> = T & {
+    new (): {
+        $slots: S;
+    };
+};
+
+declare type __VLS_WithTemplateSlots_3<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
+ */
+declare type ButtonAppearanceProp = AppearanceProp | "inverse";
+
+declare type ButtonVariantProp = VariantProp | "link";
+
+/**
+ * # EvButtonProps
+ */
+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;
+}
+
+export declare const EvCard: __VLS_WithTemplateSlots<DefineComponent<    {
+tag: {
+type: StringConstructor;
+default: string;
+};
+href: StringConstructor;
+replace: BooleanConstructor;
+to: PropType<RouteLocationRaw>;
+exact: BooleanConstructor;
+class: PropType<any>;
+style: {
+type: PropType<StyleValue>;
+default: any;
+};
+appearance: {
+type: PropType<AppearanceProp>;
+default: "default";
+};
+disabled: BooleanConstructor;
+elevation: {
+type: PropType<SurfaceElevation>;
+default: string;
+};
+rounded: {
+type: (StringConstructor | BooleanConstructor | NumberConstructor)[];
+default: boolean;
+};
+icon: PropType<IconValue>;
+iconAppearance: {
+type: PropType<AppearanceProp>;
+default: any;
+};
+actions: {
+type: PropType<readonly EvButtonProps[]>;
+default: () => any[];
+};
+justifyActions: {
+type: PropType<JustifyContentValue>;
+default: string;
+};
+eyebrow: StringConstructor;
+size: {
+type: PropType<EvCardContentSize>;
+default: string;
+};
+text: (ArrayConstructor | StringConstructor)[];
+title: StringConstructor;
+variant: {
+type: PropType<VariantProp>;
+default: string;
+};
+}, {}, unknown, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, VNodeProps & AllowedComponentProps & ComponentCustomProps, Readonly<ExtractPropTypes<    {
+tag: {
+type: StringConstructor;
+default: string;
+};
+href: StringConstructor;
+replace: BooleanConstructor;
+to: PropType<RouteLocationRaw>;
+exact: BooleanConstructor;
+class: PropType<any>;
+style: {
+type: PropType<StyleValue>;
+default: any;
+};
+appearance: {
+type: PropType<AppearanceProp>;
+default: "default";
+};
+disabled: BooleanConstructor;
+elevation: {
+type: PropType<SurfaceElevation>;
+default: string;
+};
+rounded: {
+type: (StringConstructor | BooleanConstructor | NumberConstructor)[];
+default: boolean;
+};
+icon: PropType<IconValue>;
+iconAppearance: {
+type: PropType<AppearanceProp>;
+default: any;
+};
+actions: {
+type: PropType<readonly EvButtonProps[]>;
+default: () => any[];
+};
+justifyActions: {
+type: PropType<JustifyContentValue>;
+default: string;
+};
+eyebrow: StringConstructor;
+size: {
+type: PropType<EvCardContentSize>;
+default: string;
+};
+text: (ArrayConstructor | StringConstructor)[];
+title: StringConstructor;
+variant: {
+type: PropType<VariantProp>;
+default: string;
+};
+}>>, {
+replace: boolean;
+disabled: boolean;
+appearance: AppearanceProp;
+variant: VariantProp;
+size: EvCardContentSize;
+style: StyleValue;
+rounded: string | number | boolean;
+exact: boolean;
+tag: string;
+elevation: SurfaceElevation;
+iconAppearance: AppearanceProp;
+actions: readonly EvButtonProps[];
+justifyActions: JustifyContentValue;
+}, {}>, Readonly<{
+    actions(): never;
+    default(): never;
+    header(): never;
+    icon(): never;
+    image(): never;
+    prefix(): never;
+    suffix(): never;
+    text(): never;
+}>>;
+
+export declare const EvCardActions: __VLS_WithTemplateSlots_2<DefineComponent<    {
+class: PropType<any>;
+style: {
+type: PropType<StyleValue>;
+default: any;
+};
+items: {
+type: PropType<readonly EvButtonProps[]>;
+default: () => any[];
+};
+justify: {
+type: PropType<JustifyContentValue>;
+default: string;
+};
+size: {
+type: PropType<EvCardContentSize>;
+default: string;
+};
+}, {}, unknown, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, VNodeProps & AllowedComponentProps & ComponentCustomProps, Readonly<ExtractPropTypes<    {
+class: PropType<any>;
+style: {
+type: PropType<StyleValue>;
+default: any;
+};
+items: {
+type: PropType<readonly EvButtonProps[]>;
+default: () => any[];
+};
+justify: {
+type: PropType<JustifyContentValue>;
+default: string;
+};
+size: {
+type: PropType<EvCardContentSize>;
+default: string;
+};
+}>>, {
+size: EvCardContentSize;
+style: StyleValue;
+justify: JustifyContentValue;
+items: readonly EvButtonProps[];
+}, {}>, Readonly<{
+    default(): never;
+}>>;
+
+export declare const EvCardContent: __VLS_WithTemplateSlots_3<DefineComponent<    {
+class: PropType<any>;
+style: {
+type: PropType<StyleValue>;
+default: any;
+};
+appearance: PropType<AppearanceProp>;
+eyebrow: StringConstructor;
+icon: PropType<IconValue>;
+size: {
+type: PropType<EvCardContentSize>;
+default: string;
+};
+text: (ArrayConstructor | StringConstructor)[];
+title: StringConstructor;
+}, {}, unknown, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, VNodeProps & AllowedComponentProps & ComponentCustomProps, Readonly<ExtractPropTypes<    {
+class: PropType<any>;
+style: {
+type: PropType<StyleValue>;
+default: any;
+};
+appearance: PropType<AppearanceProp>;
+eyebrow: StringConstructor;
+icon: PropType<IconValue>;
+size: {
+type: PropType<EvCardContentSize>;
+default: string;
+};
+text: (ArrayConstructor | StringConstructor)[];
+title: StringConstructor;
+}>>, {
+size: EvCardContentSize;
+style: StyleValue;
+}, {}>, Readonly<{
+    default(): never;
+    icon(): never;
+    title(): never;
+}>>;
+
+export declare type EvCardContentSize = "small" | "medium" | "large" | "x-large";
+
+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];
+
+/** Justify Content **/
+declare type JustifyContentValue = "start" | "end" | "center" | "space-between" | "space-around" | "space-evenly";
+
+export declare const makeEvCardActionsProps: <Defaults extends {
+    class?: unknown;
+    style?: unknown;
+    items?: unknown;
+    justify?: unknown;
+    size?: unknown;
+} = {}>(defaults?: Defaults) => {
+    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"];
+    };
+    items: unknown extends Defaults["items"] ? {
+        type: PropType<readonly EvButtonProps[]>;
+        default: () => any[];
+    } : Omit<{
+        type: PropType<readonly EvButtonProps[]>;
+        default: () => any[];
+    }, "type" | "default"> & {
+        type: PropType<unknown extends Defaults["items"] ? readonly EvButtonProps[] : readonly EvButtonProps[] | Defaults["items"]>;
+        default: unknown extends Defaults["items"] ? readonly EvButtonProps[] : readonly EvButtonProps[] | Defaults["items"];
+    };
+    justify: unknown extends Defaults["justify"] ? {
+        type: PropType<JustifyContentValue>;
+        default: string;
+    } : Omit<{
+        type: PropType<JustifyContentValue>;
+        default: string;
+    }, "type" | "default"> & {
+        type: PropType<unknown extends Defaults["justify"] ? JustifyContentValue : Defaults["justify"] | NonNullable<JustifyContentValue>>;
+        default: unknown extends Defaults["justify"] ? JustifyContentValue : Defaults["justify"] | NonNullable<JustifyContentValue>;
+    };
+    size: unknown extends Defaults["size"] ? {
+        type: PropType<EvCardContentSize>;
+        default: string;
+    } : Omit<{
+        type: PropType<EvCardContentSize>;
+        default: string;
+    }, "type" | "default"> & {
+        type: PropType<unknown extends Defaults["size"] ? EvCardContentSize : NonNullable<EvCardContentSize> | Defaults["size"]>;
+        default: unknown extends Defaults["size"] ? EvCardContentSize : NonNullable<EvCardContentSize> | Defaults["size"];
+    };
+};
+
+export declare const makeEvCardContentProps: <Defaults extends {
+    class?: unknown;
+    style?: unknown;
+    appearance?: unknown;
+    eyebrow?: unknown;
+    icon?: unknown;
+    size?: unknown;
+    text?: unknown;
+    title?: unknown;
+} = {}>(defaults?: Defaults) => {
+    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"];
+    };
+    appearance: unknown extends Defaults["appearance"] ? PropType<AppearanceProp> : {
+        type: PropType<unknown extends Defaults["appearance"] ? AppearanceProp : NonNullable<AppearanceProp> | Defaults["appearance"]>;
+        default: unknown extends Defaults["appearance"] ? AppearanceProp : NonNullable<AppearanceProp> | Defaults["appearance"];
+    };
+    eyebrow: unknown extends Defaults["eyebrow"] ? StringConstructor : {
+        type: PropType<unknown extends Defaults["eyebrow"] ? string : string | Defaults["eyebrow"]>;
+        default: unknown extends Defaults["eyebrow"] ? string : string | Defaults["eyebrow"];
+    };
+    icon: unknown extends Defaults["icon"] ? PropType<IconValue> : {
+        type: PropType<unknown extends Defaults["icon"] ? IconValue : NonNullable<IconValue> | Defaults["icon"]>;
+        default: unknown extends Defaults["icon"] ? IconValue : NonNullable<IconValue> | Defaults["icon"];
+    };
+    size: unknown extends Defaults["size"] ? {
+        type: PropType<EvCardContentSize>;
+        default: string;
+    } : Omit<{
+        type: PropType<EvCardContentSize>;
+        default: string;
+    }, "type" | "default"> & {
+        type: PropType<unknown extends Defaults["size"] ? EvCardContentSize : Defaults["size"] | NonNullable<EvCardContentSize>>;
+        default: unknown extends Defaults["size"] ? EvCardContentSize : Defaults["size"] | NonNullable<EvCardContentSize>;
+    };
+    text: unknown extends Defaults["text"] ? (ArrayConstructor | StringConstructor)[] : {
+        type: PropType<unknown extends Defaults["text"] ? string | unknown[] : Defaults["text"] | NonNullable<string | unknown[]>>;
+        default: unknown extends Defaults["text"] ? string | unknown[] : Defaults["text"] | NonNullable<string | unknown[]>;
+    };
+    title: unknown extends Defaults["title"] ? StringConstructor : {
+        type: PropType<unknown extends Defaults["title"] ? string : string | Defaults["title"]>;
+        default: unknown extends Defaults["title"] ? string : string | Defaults["title"];
+    };
+};
+
+export declare const makeEvCardProps: <Defaults extends {
+    tag?: unknown;
+    href?: unknown;
+    replace?: unknown;
+    to?: unknown;
+    exact?: unknown;
+    class?: unknown;
+    style?: unknown;
+    appearance?: unknown;
+    disabled?: unknown;
+    elevation?: unknown;
+    rounded?: unknown;
+    icon?: unknown;
+    iconAppearance?: unknown;
+    actions?: unknown;
+    justifyActions?: unknown;
+    eyebrow?: unknown;
+    size?: unknown;
+    text?: unknown;
+    title?: unknown;
+    variant?: unknown;
+} = {}>(defaults?: Defaults) => {
+    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"];
+    };
+    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"];
+    };
+    appearance: unknown extends Defaults["appearance"] ? {
+        type: PropType<AppearanceProp>;
+        default: "default";
+    } : Omit<{
+        type: PropType<AppearanceProp>;
+        default: "default";
+    }, "type" | "default"> & {
+        type: PropType<unknown extends Defaults["appearance"] ? AppearanceProp : NonNullable<AppearanceProp> | Defaults["appearance"]>;
+        default: unknown extends Defaults["appearance"] ? AppearanceProp : NonNullable<AppearanceProp> | Defaults["appearance"];
+    };
+    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"];
+    };
+    elevation: unknown extends Defaults["elevation"] ? {
+        type: PropType<SurfaceElevation>;
+        default: string;
+    } : Omit<{
+        type: PropType<SurfaceElevation>;
+        default: string;
+    }, "type" | "default"> & {
+        type: PropType<unknown extends Defaults["elevation"] ? SurfaceElevation : NonNullable<SurfaceElevation> | Defaults["elevation"]>;
+        default: unknown extends Defaults["elevation"] ? SurfaceElevation : NonNullable<SurfaceElevation> | Defaults["elevation"];
+    };
+    rounded: unknown extends Defaults["rounded"] ? {
+        type: (StringConstructor | BooleanConstructor | NumberConstructor)[];
+        default: boolean;
+    } : Omit<{
+        type: (StringConstructor | BooleanConstructor | NumberConstructor)[];
+        default: boolean;
+    }, "type" | "default"> & {
+        type: PropType<unknown extends Defaults["rounded"] ? string | number | boolean : NonNullable<string | number | boolean> | Defaults["rounded"]>;
+        default: unknown extends Defaults["rounded"] ? string | number | boolean : NonNullable<string | number | boolean> | Defaults["rounded"];
+    };
+    icon: unknown extends Defaults["icon"] ? PropType<IconValue> : {
+        type: PropType<unknown extends Defaults["icon"] ? IconValue : NonNullable<IconValue> | Defaults["icon"]>;
+        default: unknown extends Defaults["icon"] ? IconValue : NonNullable<IconValue> | Defaults["icon"];
+    };
+    iconAppearance: unknown extends Defaults["iconAppearance"] ? {
+        type: PropType<AppearanceProp>;
+        default: any;
+    } : Omit<{
+        type: PropType<AppearanceProp>;
+        default: any;
+    }, "type" | "default"> & {
+        type: PropType<unknown extends Defaults["iconAppearance"] ? AppearanceProp : NonNullable<AppearanceProp> | Defaults["iconAppearance"]>;
+        default: unknown extends Defaults["iconAppearance"] ? AppearanceProp : NonNullable<AppearanceProp> | Defaults["iconAppearance"];
+    };
+    actions: unknown extends Defaults["actions"] ? {
+        type: PropType<readonly EvButtonProps[]>;
+        default: () => any[];
+    } : Omit<{
+        type: PropType<readonly EvButtonProps[]>;
+        default: () => any[];
+    }, "type" | "default"> & {
+        type: PropType<unknown extends Defaults["actions"] ? readonly EvButtonProps[] : readonly EvButtonProps[] | Defaults["actions"]>;
+        default: unknown extends Defaults["actions"] ? readonly EvButtonProps[] : readonly EvButtonProps[] | Defaults["actions"];
+    };
+    justifyActions: unknown extends Defaults["justifyActions"] ? {
+        type: PropType<JustifyContentValue>;
+        default: string;
+    } : Omit<{
+        type: PropType<JustifyContentValue>;
+        default: string;
+    }, "type" | "default"> & {
+        type: PropType<unknown extends Defaults["justifyActions"] ? JustifyContentValue : NonNullable<JustifyContentValue> | Defaults["justifyActions"]>;
+        default: unknown extends Defaults["justifyActions"] ? JustifyContentValue : NonNullable<JustifyContentValue> | Defaults["justifyActions"];
+    };
+    eyebrow: unknown extends Defaults["eyebrow"] ? StringConstructor : {
+        type: PropType<unknown extends Defaults["eyebrow"] ? string : string | Defaults["eyebrow"]>;
+        default: unknown extends Defaults["eyebrow"] ? string : string | Defaults["eyebrow"];
+    };
+    size: unknown extends Defaults["size"] ? {
+        type: PropType<EvCardContentSize>;
+        default: string;
+    } : Omit<{
+        type: PropType<EvCardContentSize>;
+        default: string;
+    }, "type" | "default"> & {
+        type: PropType<unknown extends Defaults["size"] ? EvCardContentSize : NonNullable<EvCardContentSize> | Defaults["size"]>;
+        default: unknown extends Defaults["size"] ? EvCardContentSize : NonNullable<EvCardContentSize> | Defaults["size"];
+    };
+    text: unknown extends Defaults["text"] ? (ArrayConstructor | StringConstructor)[] : {
+        type: PropType<unknown extends Defaults["text"] ? string | unknown[] : NonNullable<string | unknown[]> | Defaults["text"]>;
+        default: unknown extends Defaults["text"] ? string | unknown[] : NonNullable<string | unknown[]> | Defaults["text"];
+    };
+    title: unknown extends Defaults["title"] ? StringConstructor : {
+        type: PropType<unknown extends Defaults["title"] ? string : string | Defaults["title"]>;
+        default: unknown extends Defaults["title"] ? string : string | Defaults["title"];
+    };
+    variant: unknown extends Defaults["variant"] ? {
+        type: PropType<VariantProp>;
+        default: string;
+    } : Omit<{
+        type: PropType<VariantProp>;
+        default: string;
+    }, "type" | "default"> & {
+        type: PropType<unknown extends Defaults["variant"] ? VariantProp : NonNullable<VariantProp> | Defaults["variant"]>;
+        default: unknown extends Defaults["variant"] ? VariantProp : NonNullable<VariantProp> | 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;
+}
+
+/**
+ * # Surface Elevation
+ *
+ * Elevations are the layered surfaces that form the foundation of the UI.
+ * They create a blank canvas containing other UI components.
+ * Such as text, icons, backgrounds, and borders.
+ *
+ */
+declare type SurfaceElevation = "default" | "panel" | "overlay" | "sunken";
+
+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>;
+}
+