@indielayer/ui 2.0.0 → 2.1.0

package/lib/components/input/Input.vue.d.ts

@@ -5,64 +5,139 @@ declare const inputProps: {
     showPasswordToggle: {
         type: BooleanConstructor;
         default: boolean;
+        description: string;
     };
     dir: {
         type: PropType<"rtl" | "ltr">;
         default: string;
+        description: string;
+    };
+    icon: {
+        type: StringConstructor;
+        description: string;
+    };
+    iconLeft: {
+        type: StringConstructor;
+        description: string;
+    };
+    iconRight: {
+        type: StringConstructor;
+        description: string;
+    };
+    max: {
+        type: (StringConstructor | NumberConstructor)[];
+        description: string;
+    };
+    maxlength: {
+        type: (StringConstructor | NumberConstructor)[];
+        description: string;
+    };
+    min: {
+        type: (StringConstructor | NumberConstructor)[];
+        description: string;
+    };
+    minlength: {
+        type: (StringConstructor | NumberConstructor)[];
+        description: string;
+    };
+    placeholder: {
+        type: StringConstructor;
+        description: string;
     };
-    icon: StringConstructor;
-    iconLeft: StringConstructor;
-    iconRight: StringConstructor;
-    max: (StringConstructor | NumberConstructor)[];
-    maxlength: (StringConstructor | NumberConstructor)[];
-    min: (StringConstructor | NumberConstructor)[];
-    minlength: (StringConstructor | NumberConstructor)[];
-    placeholder: StringConstructor;
     type: {
         type: StringConstructor;
         default: string;
+        description: string;
+    };
+    step: {
+        type: (StringConstructor | NumberConstructor)[];
+        description: string;
     };
-    step: (StringConstructor | NumberConstructor)[];
     block: import("vue").Prop<boolean | undefined>;
     showCounter: import("vue").Prop<boolean | undefined>;
     clearable: import("vue").Prop<boolean | undefined>;
     modelValue: {
         readonly type: PropType<string | number | boolean | object | any[] | undefined>;
         readonly default: undefined;
+        readonly description: "Bound value (v-model).";
+    };
+    id: {
+        readonly type: StringConstructor;
+        readonly description: "Native id attribute for the input element.";
+    };
+    name: {
+        readonly type: StringConstructor;
+        readonly description: "Native name attribute for form submission.";
+    };
+    readonly: {
+        readonly type: BooleanConstructor;
+        readonly description: "Makes the field read-only without disabling it.";
+    };
+    required: {
+        readonly type: BooleanConstructor;
+        readonly description: "Marks the field as required for validation.";
     };
-    id: StringConstructor;
-    name: StringConstructor;
-    readonly: BooleanConstructor;
-    required: BooleanConstructor;
     validateOnInput: {
         readonly type: BooleanConstructor;
         readonly default: true;
+        readonly description: "Runs validation on each input event when true.";
+    };
+    label: {
+        readonly type: StringConstructor;
+        readonly description: "Visible label text for the field.";
+    };
+    helper: {
+        readonly type: StringConstructor;
+        readonly description: "Helper text shown below the field.";
+    };
+    error: {
+        readonly type: StringConstructor;
+        readonly description: "External error message; overrides rule errors when set.";
+    };
+    hideFooter: {
+        readonly type: BooleanConstructor;
+        readonly description: "Hides the footer area (helper / error).";
     };
-    label: StringConstructor;
-    helper: StringConstructor;
-    error: StringConstructor;
-    hideFooter: BooleanConstructor;
     rules: {
         readonly type: ArrayConstructor;
         readonly default: () => never[];
+        readonly description: "Validation rule functions or rule descriptors.";
+    };
+    tooltip: {
+        readonly type: StringConstructor;
+        readonly description: "Optional tooltip text next to the label.";
+    };
+    skipFormRegistry: {
+        readonly type: BooleanConstructor;
+        readonly description: "Skips registering this field with a parent x-form.";
+    };
+    disabled: {
+        readonly type: BooleanConstructor;
+        readonly description: "Disables interaction and applies disabled styling.";
+    };
+    loading: {
+        readonly type: BooleanConstructor;
+        readonly description: "Shows a loading indicator and blocks interaction.";
+    };
+    loadingLabel: {
+        readonly type: StringConstructor;
+        readonly description: "Accessible label announced while loading.";
     };
-    tooltip: StringConstructor;
-    skipFormRegistry: BooleanConstructor;
-    disabled: BooleanConstructor;
-    loading: BooleanConstructor;
-    loadingLabel: StringConstructor;
     loadingStatus: {
         readonly type: PropType<import("../loader/Loader.vue").LoaderStatus>;
         readonly default: "active";
+        readonly description: "Loader visual status (for example active or indeterminate).";
     };
     color: {
         readonly type: StringConstructor;
         readonly default: string | undefined;
+        readonly description: "Theme or CSS color used for the control accents.";
     };
     size: {
         readonly type: PropType<Size>;
         readonly default: "md";
         readonly validator: (value: string) => boolean;
+        readonly description: "Control size. One of xs, sm, md, lg, xl.";
     };
 };
 export type InputProps = ExtractPublicPropTypes<typeof inputProps>;
@@ -78,64 +153,139 @@ declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<im
     showPasswordToggle: {
         type: BooleanConstructor;
         default: boolean;
+        description: string;
     };
     dir: {
         type: PropType<"rtl" | "ltr">;
         default: string;
+        description: string;
+    };
+    icon: {
+        type: StringConstructor;
+        description: string;
+    };
+    iconLeft: {
+        type: StringConstructor;
+        description: string;
+    };
+    iconRight: {
+        type: StringConstructor;
+        description: string;
+    };
+    max: {
+        type: (StringConstructor | NumberConstructor)[];
+        description: string;
+    };
+    maxlength: {
+        type: (StringConstructor | NumberConstructor)[];
+        description: string;
+    };
+    min: {
+        type: (StringConstructor | NumberConstructor)[];
+        description: string;
+    };
+    minlength: {
+        type: (StringConstructor | NumberConstructor)[];
+        description: string;
+    };
+    placeholder: {
+        type: StringConstructor;
+        description: string;
     };
-    icon: StringConstructor;
-    iconLeft: StringConstructor;
-    iconRight: StringConstructor;
-    max: (StringConstructor | NumberConstructor)[];
-    maxlength: (StringConstructor | NumberConstructor)[];
-    min: (StringConstructor | NumberConstructor)[];
-    minlength: (StringConstructor | NumberConstructor)[];
-    placeholder: StringConstructor;
     type: {
         type: StringConstructor;
         default: string;
+        description: string;
+    };
+    step: {
+        type: (StringConstructor | NumberConstructor)[];
+        description: string;
     };
-    step: (StringConstructor | NumberConstructor)[];
     block: import("vue").Prop<boolean | undefined>;
     showCounter: import("vue").Prop<boolean | undefined>;
     clearable: import("vue").Prop<boolean | undefined>;
     modelValue: {
         readonly type: PropType<string | number | boolean | object | any[] | undefined>;
         readonly default: undefined;
+        readonly description: "Bound value (v-model).";
+    };
+    id: {
+        readonly type: StringConstructor;
+        readonly description: "Native id attribute for the input element.";
+    };
+    name: {
+        readonly type: StringConstructor;
+        readonly description: "Native name attribute for form submission.";
+    };
+    readonly: {
+        readonly type: BooleanConstructor;
+        readonly description: "Makes the field read-only without disabling it.";
+    };
+    required: {
+        readonly type: BooleanConstructor;
+        readonly description: "Marks the field as required for validation.";
     };
-    id: StringConstructor;
-    name: StringConstructor;
-    readonly: BooleanConstructor;
-    required: BooleanConstructor;
     validateOnInput: {
         readonly type: BooleanConstructor;
         readonly default: true;
+        readonly description: "Runs validation on each input event when true.";
+    };
+    label: {
+        readonly type: StringConstructor;
+        readonly description: "Visible label text for the field.";
+    };
+    helper: {
+        readonly type: StringConstructor;
+        readonly description: "Helper text shown below the field.";
+    };
+    error: {
+        readonly type: StringConstructor;
+        readonly description: "External error message; overrides rule errors when set.";
+    };
+    hideFooter: {
+        readonly type: BooleanConstructor;
+        readonly description: "Hides the footer area (helper / error).";
     };
-    label: StringConstructor;
-    helper: StringConstructor;
-    error: StringConstructor;
-    hideFooter: BooleanConstructor;
     rules: {
         readonly type: ArrayConstructor;
         readonly default: () => never[];
+        readonly description: "Validation rule functions or rule descriptors.";
+    };
+    tooltip: {
+        readonly type: StringConstructor;
+        readonly description: "Optional tooltip text next to the label.";
+    };
+    skipFormRegistry: {
+        readonly type: BooleanConstructor;
+        readonly description: "Skips registering this field with a parent x-form.";
+    };
+    disabled: {
+        readonly type: BooleanConstructor;
+        readonly description: "Disables interaction and applies disabled styling.";
+    };
+    loading: {
+        readonly type: BooleanConstructor;
+        readonly description: "Shows a loading indicator and blocks interaction.";
+    };
+    loadingLabel: {
+        readonly type: StringConstructor;
+        readonly description: "Accessible label announced while loading.";
     };
-    tooltip: StringConstructor;
-    skipFormRegistry: BooleanConstructor;
-    disabled: BooleanConstructor;
-    loading: BooleanConstructor;
-    loadingLabel: StringConstructor;
     loadingStatus: {
         readonly type: PropType<import("../loader/Loader.vue").LoaderStatus>;
         readonly default: "active";
+        readonly description: "Loader visual status (for example active or indeterminate).";
     };
     color: {
         readonly type: StringConstructor;
         readonly default: string | undefined;
+        readonly description: "Theme or CSS color used for the control accents.";
     };
     size: {
         readonly type: PropType<Size>;
         readonly default: "md";
         readonly validator: (value: string) => boolean;
+        readonly description: "Control size. One of xs, sm, md, lg, xl.";
     };
 }>, {
     focus: () => void | undefined;
@@ -147,64 +297,139 @@ declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<im
     showPasswordToggle: {
         type: BooleanConstructor;
         default: boolean;
+        description: string;
     };
     dir: {
         type: PropType<"rtl" | "ltr">;
         default: string;
+        description: string;
+    };
+    icon: {
+        type: StringConstructor;
+        description: string;
+    };
+    iconLeft: {
+        type: StringConstructor;
+        description: string;
+    };
+    iconRight: {
+        type: StringConstructor;
+        description: string;
+    };
+    max: {
+        type: (StringConstructor | NumberConstructor)[];
+        description: string;
+    };
+    maxlength: {
+        type: (StringConstructor | NumberConstructor)[];
+        description: string;
+    };
+    min: {
+        type: (StringConstructor | NumberConstructor)[];
+        description: string;
+    };
+    minlength: {
+        type: (StringConstructor | NumberConstructor)[];
+        description: string;
+    };
+    placeholder: {
+        type: StringConstructor;
+        description: string;
     };
-    icon: StringConstructor;
-    iconLeft: StringConstructor;
-    iconRight: StringConstructor;
-    max: (StringConstructor | NumberConstructor)[];
-    maxlength: (StringConstructor | NumberConstructor)[];
-    min: (StringConstructor | NumberConstructor)[];
-    minlength: (StringConstructor | NumberConstructor)[];
-    placeholder: StringConstructor;
     type: {
         type: StringConstructor;
         default: string;
+        description: string;
+    };
+    step: {
+        type: (StringConstructor | NumberConstructor)[];
+        description: string;
     };
-    step: (StringConstructor | NumberConstructor)[];
     block: import("vue").Prop<boolean | undefined>;
     showCounter: import("vue").Prop<boolean | undefined>;
     clearable: import("vue").Prop<boolean | undefined>;
     modelValue: {
         readonly type: PropType<string | number | boolean | object | any[] | undefined>;
         readonly default: undefined;
+        readonly description: "Bound value (v-model).";
+    };
+    id: {
+        readonly type: StringConstructor;
+        readonly description: "Native id attribute for the input element.";
+    };
+    name: {
+        readonly type: StringConstructor;
+        readonly description: "Native name attribute for form submission.";
+    };
+    readonly: {
+        readonly type: BooleanConstructor;
+        readonly description: "Makes the field read-only without disabling it.";
+    };
+    required: {
+        readonly type: BooleanConstructor;
+        readonly description: "Marks the field as required for validation.";
     };
-    id: StringConstructor;
-    name: StringConstructor;
-    readonly: BooleanConstructor;
-    required: BooleanConstructor;
     validateOnInput: {
         readonly type: BooleanConstructor;
         readonly default: true;
+        readonly description: "Runs validation on each input event when true.";
+    };
+    label: {
+        readonly type: StringConstructor;
+        readonly description: "Visible label text for the field.";
+    };
+    helper: {
+        readonly type: StringConstructor;
+        readonly description: "Helper text shown below the field.";
+    };
+    error: {
+        readonly type: StringConstructor;
+        readonly description: "External error message; overrides rule errors when set.";
+    };
+    hideFooter: {
+        readonly type: BooleanConstructor;
+        readonly description: "Hides the footer area (helper / error).";
     };
-    label: StringConstructor;
-    helper: StringConstructor;
-    error: StringConstructor;
-    hideFooter: BooleanConstructor;
     rules: {
         readonly type: ArrayConstructor;
         readonly default: () => never[];
+        readonly description: "Validation rule functions or rule descriptors.";
+    };
+    tooltip: {
+        readonly type: StringConstructor;
+        readonly description: "Optional tooltip text next to the label.";
+    };
+    skipFormRegistry: {
+        readonly type: BooleanConstructor;
+        readonly description: "Skips registering this field with a parent x-form.";
+    };
+    disabled: {
+        readonly type: BooleanConstructor;
+        readonly description: "Disables interaction and applies disabled styling.";
+    };
+    loading: {
+        readonly type: BooleanConstructor;
+        readonly description: "Shows a loading indicator and blocks interaction.";
+    };
+    loadingLabel: {
+        readonly type: StringConstructor;
+        readonly description: "Accessible label announced while loading.";
     };
-    tooltip: StringConstructor;
-    skipFormRegistry: BooleanConstructor;
-    disabled: BooleanConstructor;
-    loading: BooleanConstructor;
-    loadingLabel: StringConstructor;
     loadingStatus: {
         readonly type: PropType<import("../loader/Loader.vue").LoaderStatus>;
         readonly default: "active";
+        readonly description: "Loader visual status (for example active or indeterminate).";
     };
     color: {
         readonly type: StringConstructor;
         readonly default: string | undefined;
+        readonly description: "Theme or CSS color used for the control accents.";
     };
     size: {
         readonly type: PropType<Size>;
         readonly default: "md";
         readonly validator: (value: string) => boolean;
+        readonly description: "Control size. One of xs, sm, md, lg, xl.";
     };
 }>> & Readonly<{
     [x: `on${Capitalize<string>}`]: ((...args: any[]) => any) | undefined;

package/lib/components/input/Input.vue_vue_type_script_setup_true_lang.js

@@ -33,31 +33,69 @@ var D = { class: "relative" }, O = [
 	...l.props(),
 	showPasswordToggle: {
 		type: Boolean,
-		default: !0
+		default: !0,
+		description: "Shows a visibility toggle when `type` is `password`."
 	},
 	dir: {
 		type: String,
-		default: "ltr"
+		default: "ltr",
+		description: "Text direction for the native input (`ltr` or `rtl`)."
+	},
+	icon: {
+		type: String,
+		description: "Shortcut for `iconLeft`."
+	},
+	iconLeft: {
+		type: String,
+		description: "Icon name shown before the input value."
+	},
+	iconRight: {
+		type: String,
+		description: "Icon name shown after the input value."
+	},
+	max: {
+		type: [Number, String],
+		description: "Native `max` attribute (typically for number inputs)."
+	},
+	maxlength: {
+		type: [Number, String],
+		description: "Maximum character length for the input value."
+	},
+	min: {
+		type: [Number, String],
+		description: "Native `min` attribute (typically for number inputs)."
+	},
+	minlength: {
+		type: [Number, String],
+		description: "Minimum character length for the input value."
+	},
+	placeholder: {
+		type: String,
+		description: "Placeholder text shown when the value is empty."
 	},
-	icon: String,
-	iconLeft: String,
-	iconRight: String,
-	max: [Number, String],
-	maxlength: [Number, String],
-	min: [Number, String],
-	minlength: [Number, String],
-	placeholder: String,
 	type: {
 		type: String,
-		default: "text"
+		default: "text",
+		description: "Native input type (text, password, email, number, etc.)."
+	},
+	step: {
+		type: [Number, String],
+		description: "Native `step` attribute for numeric inputs."
 	},
-	step: [Number, String],
-	block: r(),
-	showCounter: r(),
-	clearable: r()
+	block: r("Stretches to the full width of the parent."),
+	showCounter: r("Shows a character counter in the footer."),
+	clearable: r("Shows a clear button when the value is not empty.")
 }, A = /* @__PURE__ */ g({
 	name: "XInput",
 	validators: { ...i.validators() },
+	docs: {
+		slots: {
+			prefix: "Content before the input (left adornment).",
+			suffix: "Content after the input (right adornment)."
+		},
+		emits: { ...l.emitDocs() },
+		methods: { ...l.methodDocs() }
+	},
 	props: k,
 	emits: l.emits(),
 	setup(n, { expose: r, emit: i }) {

package/lib/components/inputFooter/InputFooter.vue.d.ts

@@ -1,10 +1,22 @@
 import type { ExtractPublicPropTypes } from 'vue';
 import { type ThemeComponent } from '../../composables/useTheme';
 declare const inputFooterProps: {
-    helper: StringConstructor;
-    error: StringConstructor;
-    characterCount: NumberConstructor;
-    maxCharacters: (StringConstructor | NumberConstructor)[];
+    helper: {
+        type: StringConstructor;
+        description: string;
+    };
+    error: {
+        type: StringConstructor;
+        description: string;
+    };
+    characterCount: {
+        type: NumberConstructor;
+        description: string;
+    };
+    maxCharacters: {
+        type: (StringConstructor | NumberConstructor)[];
+        description: string;
+    };
     showCounter: import("vue").Prop<boolean | undefined>;
 };
 export type InputFooterProps = ExtractPublicPropTypes<typeof inputFooterProps>;
@@ -12,16 +24,40 @@ type InternalClasses = 'wrapper' | 'helperText' | 'errorText' | 'container' | 'c
 export interface InputFooterTheme extends ThemeComponent<InputFooterProps, InternalClasses> {
 }
 declare const _default: import("vue").DefineComponent<import("vue").ExtractPropTypes<{
-    helper: StringConstructor;
-    error: StringConstructor;
-    characterCount: NumberConstructor;
-    maxCharacters: (StringConstructor | NumberConstructor)[];
+    helper: {
+        type: StringConstructor;
+        description: string;
+    };
+    error: {
+        type: StringConstructor;
+        description: string;
+    };
+    characterCount: {
+        type: NumberConstructor;
+        description: string;
+    };
+    maxCharacters: {
+        type: (StringConstructor | NumberConstructor)[];
+        description: string;
+    };
     showCounter: import("vue").Prop<boolean | undefined>;
 }>, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
-    helper: StringConstructor;
-    error: StringConstructor;
-    characterCount: NumberConstructor;
-    maxCharacters: (StringConstructor | NumberConstructor)[];
+    helper: {
+        type: StringConstructor;
+        description: string;
+    };
+    error: {
+        type: StringConstructor;
+        description: string;
+    };
+    characterCount: {
+        type: NumberConstructor;
+        description: string;
+    };
+    maxCharacters: {
+        type: (StringConstructor | NumberConstructor)[];
+        description: string;
+    };
     showCounter: import("vue").Prop<boolean | undefined>;
 }>> & Readonly<{}>, {}, {}, {}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>;
 export default _default;

package/lib/components/inputFooter/InputFooter.vue_vue_type_script_setup_true_lang.js

@@ -4,12 +4,25 @@ import { computed as n, createCommentVNode as r, createElementBlock as i, create
 //#region src/components/inputFooter/InputFooter.vue?vue&type=script&setup=true&lang.ts
 var f = /* @__PURE__ */ o({
 	name: "XInputFooter",
+	docs: {},
 	props: {
-		helper: String,
-		error: String,
-		characterCount: Number,
-		maxCharacters: [Number, String],
-		showCounter: t()
+		helper: {
+			type: String,
+			description: "Helper text shown when there is no error."
+		},
+		error: {
+			type: String,
+			description: "Error message; takes priority over helper text."
+		},
+		characterCount: {
+			type: Number,
+			description: "Current character count for the counter."
+		},
+		maxCharacters: {
+			type: [Number, String],
+			description: "Maximum characters shown as `count/max` in the counter."
+		},
+		showCounter: t("Shows the character counter.")
 	},
 	setup(t) {
 		let o = t, { styles: f, classes: p, className: m } = e("InputFooter", {}, o), h = n(() => o.maxCharacters ? Number(o.maxCharacters) : void 0), g = n(() => o.characterCount === void 0 ? "" : h.value ? `${o.characterCount}/${h.value}` : `${o.characterCount}`), _ = n(() => o.error || o.helper);