@evance/evance-ui 1.0.7 → 1.0.8

package/dist/types/EvBlock.d.ts

@@ -0,0 +1,243 @@
+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 type AlignSelfProp = AlignSelfPropValue | AlignSelfPropObject | undefined;
+
+export declare type AlignSelfPropObject = {
+    [key in DisplayBreakpoint]: AlignSelfPropValue;
+};
+
+/** Align Self Props */
+export declare type AlignSelfPropValue = "auto" | "start" | "end" | "center" | "baseline" | "stretch";
+
+/** Block Number Props */
+export declare type BlockNumber = 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12;
+
+export declare type BlockNumberProp = BlockNumberPropValue | BlockNumberPropObject | undefined;
+
+export declare type BlockNumberPropObject = {
+    [key in DisplayBreakpoint]: BlockNumberPropValue;
+};
+
+export declare type BlockNumberPropValue = BlockNumber | `${BlockNumber}`;
+
+export declare type BlockSizeProp = BlockSizePropValue | BlockSizePropObject;
+
+export declare type BlockSizePropObject = {
+    [key in DisplayBreakpoint]: BlockSizePropValue;
+};
+
+/** Block Size Props **/
+export declare type BlockSizePropValue = "auto" | "grow" | BlockNumberPropValue;
+
+declare type Breakpoint = (typeof breakpoints)[number];
+
+/**
+ * # Breakpoints
+ * Excludes `xs` as this is the smallest size - not really a breakpoint.
+ */
+declare const breakpoints: readonly ["sm", "md", "lg", "xl", "xxl"];
+
+declare type DisplayBreakpoint = "xs" | Breakpoint;
+
+declare type DisplayRuleKebab = (typeof displayRulesKebab)[number];
+
+declare type DisplayRuleKey = (typeof displayRules)[number];
+
+declare type DisplayRuleListProp = DisplayRuleKey | DisplayRuleKey[] | DisplayRuleKebab | DisplayRuleKebab[] | {
+    [key in DisplayRuleKey]?: DisplayRuleSuffix;
+};
+
+declare type DisplayRuleObject = {
+    [key in DisplayRuleKey]?: DisplayRuleValue;
+};
+
+declare type DisplayRuleProp = DisplayRuleValue | DisplayRuleObject;
+
+/**
+ * # Display Point Options
+ *
+ * These are listed in order of calculation priority.
+ */
+declare const displayRules: readonly ["xxl", "xl", "lg", "md", "sm", "xs", "xxlOnly", "xlOnly", "lgOnly", "mdOnly", "smOnly", "xsOnly", "xxlUp", "xlUp", "lgUp", "mdUp", "smUp", "xsUp", "smDown", "mdDown", "lgDown", "xlDown"];
+
+declare const displayRulesKebab: readonly ["xxl-only", "xl-only", "lg-only", "md-only", "sm-only", "xs-only", "xxl-up", "xl-up", "lg-up", "md-up", "sm-up", "xs-up", "sm-down", "md-down", "lg-down", "xl-down"];
+
+declare type DisplayRuleSuffix = "only" | "up" | "down";
+
+declare type DisplayRuleValue = number | string;
+
+export declare const EvBlock: __VLS_WithTemplateSlots<DefineComponent<    {
+tag: {
+type: StringConstructor;
+default: string;
+};
+class: PropType<any>;
+style: {
+type: PropType<StyleValue>;
+default: any;
+};
+alignSelf: PropType<AlignSelfProp>;
+offset: PropType<BlockNumberProp>;
+order: PropType<BlockNumberProp>;
+scrollable: BooleanConstructor;
+size: PropType<BlockSizeProp>;
+hidden: PropType<VisibilityRuleProp>;
+height: PropType<DisplayRuleProp>;
+width: PropType<DisplayRuleProp>;
+}, {}, unknown, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, VNodeProps & AllowedComponentProps & ComponentCustomProps, Readonly<ExtractPropTypes<    {
+tag: {
+type: StringConstructor;
+default: string;
+};
+class: PropType<any>;
+style: {
+type: PropType<StyleValue>;
+default: any;
+};
+alignSelf: PropType<AlignSelfProp>;
+offset: PropType<BlockNumberProp>;
+order: PropType<BlockNumberProp>;
+scrollable: BooleanConstructor;
+size: PropType<BlockSizeProp>;
+hidden: PropType<VisibilityRuleProp>;
+height: PropType<DisplayRuleProp>;
+width: PropType<DisplayRuleProp>;
+}>>, {
+style: StyleValue;
+tag: string;
+scrollable: boolean;
+}, {}>, {
+    default?(_: {}): any;
+}>;
+
+/**
+ * # makeEvBlockProps
+ */
+export declare const makeEvBlockProps: <Defaults extends {
+    tag?: unknown;
+    class?: unknown;
+    style?: unknown;
+    alignSelf?: unknown;
+    offset?: unknown;
+    order?: unknown;
+    scrollable?: unknown;
+    size?: unknown;
+    hidden?: unknown;
+    height?: unknown;
+    width?: 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"];
+    };
+    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"];
+    };
+    alignSelf: unknown extends Defaults["alignSelf"] ? PropType<AlignSelfProp> : {
+        type: PropType<unknown extends Defaults["alignSelf"] ? AlignSelfProp : Defaults["alignSelf"] | NonNullable<AlignSelfProp>>;
+        default: unknown extends Defaults["alignSelf"] ? AlignSelfProp : Defaults["alignSelf"] | NonNullable<AlignSelfProp>;
+    };
+    offset: unknown extends Defaults["offset"] ? PropType<BlockNumberProp> : {
+        type: PropType<unknown extends Defaults["offset"] ? BlockNumberProp : Defaults["offset"] | NonNullable<BlockNumberProp>>;
+        default: unknown extends Defaults["offset"] ? BlockNumberProp : Defaults["offset"] | NonNullable<BlockNumberProp>;
+    };
+    order: unknown extends Defaults["order"] ? PropType<BlockNumberProp> : {
+        type: PropType<unknown extends Defaults["order"] ? BlockNumberProp : NonNullable<BlockNumberProp> | Defaults["order"]>;
+        default: unknown extends Defaults["order"] ? BlockNumberProp : NonNullable<BlockNumberProp> | Defaults["order"];
+    };
+    scrollable: unknown extends Defaults["scrollable"] ? BooleanConstructor : {
+        type: PropType<unknown extends Defaults["scrollable"] ? boolean : boolean | Defaults["scrollable"]>;
+        default: unknown extends Defaults["scrollable"] ? boolean : boolean | Defaults["scrollable"];
+    };
+    size: unknown extends Defaults["size"] ? PropType<BlockSizeProp> : {
+        type: PropType<unknown extends Defaults["size"] ? BlockSizeProp : Defaults["size"] | NonNullable<BlockSizeProp>>;
+        default: unknown extends Defaults["size"] ? BlockSizeProp : Defaults["size"] | NonNullable<BlockSizeProp>;
+    };
+    hidden: unknown extends Defaults["hidden"] ? PropType<VisibilityRuleProp> : {
+        type: PropType<unknown extends Defaults["hidden"] ? unknown : {} | Defaults["hidden"]>;
+        default: unknown extends Defaults["hidden"] ? unknown : {} | Defaults["hidden"];
+    };
+    height: unknown extends Defaults["height"] ? PropType<DisplayRuleProp> : {
+        type: PropType<unknown extends Defaults["height"] ? unknown : {} | Defaults["height"]>;
+        default: unknown extends Defaults["height"] ? unknown : {} | Defaults["height"];
+    };
+    width: unknown extends Defaults["width"] ? PropType<DisplayRuleProp> : {
+        type: PropType<unknown extends Defaults["width"] ? unknown : {} | Defaults["width"]>;
+        default: unknown extends Defaults["width"] ? unknown : {} | Defaults["width"];
+    };
+};
+
+export declare type ResponsiveProp = ResponsivePropValue | ResponsivePropObject | undefined;
+
+export declare type ResponsivePropObject = {
+    [key in DisplayBreakpoint]: ResponsivePropValue;
+};
+
+/** Responsive Props */
+export declare type ResponsivePropValue = string | number | boolean;
+
+/** Visibility props */
+declare type VisibilityRuleProp = DisplayRuleListProp | boolean;
+
+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>;
+}
+