@indielayer/ui 2.0.0 → 2.1.0

package/lib/components/inputGroup/InputGroup.vue.d.ts

@@ -7,36 +7,80 @@ declare const inputGroupProps: {
     modelValue: {
         readonly type: import("vue").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: import("vue").PropType<import("../loader/Loader.vue").LoaderStatus>;
         readonly default: "active";
+        readonly description: "Loader visual status (for example active or indeterminate).";
     };
     size: {
         readonly type: import("vue").PropType<Size>;
         readonly default: "md";
         readonly validator: (value: string) => boolean;
+        readonly description: "Control size. One of xs, sm, md, lg, xl.";
     };
 };
 export type InputGroupProps = ExtractPublicPropTypes<typeof inputGroupProps>;
@@ -66,36 +110,80 @@ declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<im
     modelValue: {
         readonly type: import("vue").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: import("vue").PropType<import("../loader/Loader.vue").LoaderStatus>;
         readonly default: "active";
+        readonly description: "Loader visual status (for example active or indeterminate).";
     };
     size: {
         readonly type: import("vue").PropType<Size>;
         readonly default: "md";
         readonly validator: (value: string) => boolean;
+        readonly description: "Control size. One of xs, sm, md, lg, xl.";
     };
 }>, {
     focus: () => void;
@@ -108,36 +196,80 @@ declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<im
     modelValue: {
         readonly type: import("vue").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: import("vue").PropType<import("../loader/Loader.vue").LoaderStatus>;
         readonly default: "active";
+        readonly description: "Loader visual status (for example active or indeterminate).";
     };
     size: {
         readonly type: import("vue").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/inputGroup/InputGroup.vue_vue_type_script_setup_true_lang.js

@@ -12,10 +12,15 @@ var C = {
 	...r.props(),
 	...i.props(),
 	...a.props(),
-	block: n()
+	block: n("Stretches the group to the full width of the parent.")
 }, w = /* @__PURE__ */ f({
 	name: "XInputGroup",
 	validators: { ...r.validators() },
+	docs: {
+		slots: { default: "Grouped controls (inputs, buttons, or other adornments)." },
+		emits: { ...a.emitDocs() },
+		methods: { ...a.methodDocs() }
+	},
 	props: C,
 	emits: a.emits(),
 	setup(n, { expose: r, emit: i }) {

package/lib/components/label/Label.vue.d.ts

@@ -1,21 +1,41 @@
 import { type ExtractPublicPropTypes } from 'vue';
 import { type ThemeComponent } from '../../composables/useTheme';
 declare const labelProps: {
-    label: StringConstructor;
-    disabled: BooleanConstructor;
-    required: BooleanConstructor;
+    label: {
+        type: StringConstructor;
+        description: string;
+    };
+    disabled: {
+        type: BooleanConstructor;
+        description: string;
+    };
+    required: {
+        type: BooleanConstructor;
+        description: string;
+    };
     block: import("vue").Prop<boolean | undefined>;
-    isInsideForm: BooleanConstructor;
-    isInsideInputGroup: BooleanConstructor;
+    isInsideForm: {
+        type: BooleanConstructor;
+        description: string;
+    };
+    isInsideInputGroup: {
+        type: BooleanConstructor;
+        description: string;
+    };
     tag: {
         type: StringConstructor;
         default: string;
+        description: string;
+    };
+    tooltip: {
+        type: StringConstructor;
+        description: string;
     };
-    tooltip: StringConstructor;
     size: {
         readonly type: import("vue").PropType<import("../../composables/useCommon").Size>;
         readonly default: "md";
         readonly validator: (value: string) => boolean;
+        readonly description: "Control size. One of xs, sm, md, lg, xl.";
     };
 };
 export type LabelProps = ExtractPublicPropTypes<typeof labelProps>;
@@ -23,38 +43,78 @@ type InternalClasses = 'wrapper' | 'label';
 export interface LabelTheme extends ThemeComponent<LabelProps, InternalClasses> {
 }
 declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<import("vue").ExtractPropTypes<{
-    label: StringConstructor;
-    disabled: BooleanConstructor;
-    required: BooleanConstructor;
+    label: {
+        type: StringConstructor;
+        description: string;
+    };
+    disabled: {
+        type: BooleanConstructor;
+        description: string;
+    };
+    required: {
+        type: BooleanConstructor;
+        description: string;
+    };
     block: import("vue").Prop<boolean | undefined>;
-    isInsideForm: BooleanConstructor;
-    isInsideInputGroup: BooleanConstructor;
+    isInsideForm: {
+        type: BooleanConstructor;
+        description: string;
+    };
+    isInsideInputGroup: {
+        type: BooleanConstructor;
+        description: string;
+    };
     tag: {
         type: StringConstructor;
         default: string;
+        description: string;
+    };
+    tooltip: {
+        type: StringConstructor;
+        description: string;
     };
-    tooltip: StringConstructor;
     size: {
         readonly type: import("vue").PropType<import("../../composables/useCommon").Size>;
         readonly default: "md";
         readonly validator: (value: string) => boolean;
+        readonly description: "Control size. One of xs, sm, md, lg, xl.";
     };
 }>, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
-    label: StringConstructor;
-    disabled: BooleanConstructor;
-    required: BooleanConstructor;
+    label: {
+        type: StringConstructor;
+        description: string;
+    };
+    disabled: {
+        type: BooleanConstructor;
+        description: string;
+    };
+    required: {
+        type: BooleanConstructor;
+        description: string;
+    };
     block: import("vue").Prop<boolean | undefined>;
-    isInsideForm: BooleanConstructor;
-    isInsideInputGroup: BooleanConstructor;
+    isInsideForm: {
+        type: BooleanConstructor;
+        description: string;
+    };
+    isInsideInputGroup: {
+        type: BooleanConstructor;
+        description: string;
+    };
     tag: {
         type: StringConstructor;
         default: string;
+        description: string;
+    };
+    tooltip: {
+        type: StringConstructor;
+        description: string;
     };
-    tooltip: StringConstructor;
     size: {
         readonly type: import("vue").PropType<import("../../composables/useCommon").Size>;
         readonly default: "md";
         readonly validator: (value: string) => boolean;
+        readonly description: "Control size. One of xs, sm, md, lg, xl.";
     };
 }>> & Readonly<{}>, {
     disabled: boolean;

package/lib/components/label/Label.vue_vue_type_script_setup_true_lang.js

@@ -7,20 +7,40 @@ import { computed as a, createBlock as o, createCommentVNode as s, createElement
 //#region src/components/label/Label.vue?vue&type=script&setup=true&lang.ts
 var y = {
 	...r.props(),
-	label: String,
-	disabled: Boolean,
-	required: Boolean,
-	block: n(),
-	isInsideForm: Boolean,
-	isInsideInputGroup: Boolean,
+	label: {
+		type: String,
+		description: "Visible label text."
+	},
+	disabled: {
+		type: Boolean,
+		description: "Applies disabled styling to the label."
+	},
+	required: {
+		type: Boolean,
+		description: "Marks the label as required for form fields."
+	},
+	block: n("Stretches to the full width of the parent."),
+	isInsideForm: {
+		type: Boolean,
+		description: "Indicates the label is rendered inside a form layout."
+	},
+	isInsideInputGroup: {
+		type: Boolean,
+		description: "Indicates the label is rendered inside an input group."
+	},
 	tag: {
 		type: String,
-		default: "label"
+		default: "label",
+		description: "Root element tag. Use `fieldset` for grouped controls."
 	},
-	tooltip: String
+	tooltip: {
+		type: String,
+		description: "Tooltip text shown next to the label via a toggle tip."
+	}
 }, b = /* @__PURE__ */ l({
 	name: "XLabel",
 	validators: { ...r.validators() },
+	docs: { slots: { default: "Labeled control or content." } },
 	props: y,
 	setup(n) {
 		let r = n, l = u(e, {

package/lib/components/link/Link.js

@@ -1,6 +1,6 @@
 import e from "../../_virtual/_plugin-vue_export-helper.js";
 import t from "./Link.vue_vue_type_script_setup_true_lang.js";
-import n from "./Link.vue_vue_type_style_index_0_scoped_8e0e4d08_lang.module.js";
-var r = /* @__PURE__ */ e(t, [["__cssModules", { $style: n }], ["__scopeId", "data-v-8e0e4d08"]]);
+import n from "./Link.vue_vue_type_style_index_0_scoped_3ee61e03_lang.module.js";
+var r = /* @__PURE__ */ e(t, [["__cssModules", { $style: n }], ["__scopeId", "data-v-3ee61e03"]]);
 //#endregion
 export { r as default };

package/lib/components/link/Link.vue.d.ts

@@ -4,14 +4,19 @@ declare const linkProps: {
     tag: {
         type: StringConstructor;
         default: string;
+        description: string;
+    };
+    to: {
+        type: (ObjectConstructor | StringConstructor)[];
+        description: string;
     };
-    to: (ObjectConstructor | StringConstructor)[];
     shadow: import("vue").Prop<boolean | undefined>;
     external: import("vue").Prop<boolean | undefined>;
     underline: import("vue").Prop<boolean | undefined>;
     color: {
         readonly type: StringConstructor;
         readonly default: string | undefined;
+        readonly description: "Theme or CSS color used for the control accents.";
     };
 };
 export type LinkProps = ExtractPublicPropTypes<typeof linkProps>;
@@ -22,27 +27,37 @@ declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<im
     tag: {
         type: StringConstructor;
         default: string;
+        description: string;
+    };
+    to: {
+        type: (ObjectConstructor | StringConstructor)[];
+        description: string;
     };
-    to: (ObjectConstructor | StringConstructor)[];
     shadow: import("vue").Prop<boolean | undefined>;
     external: import("vue").Prop<boolean | undefined>;
     underline: import("vue").Prop<boolean | undefined>;
     color: {
         readonly type: StringConstructor;
         readonly default: string | undefined;
+        readonly description: "Theme or CSS color used for the control accents.";
     };
 }>, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
     tag: {
         type: StringConstructor;
         default: string;
+        description: string;
+    };
+    to: {
+        type: (ObjectConstructor | StringConstructor)[];
+        description: string;
     };
-    to: (ObjectConstructor | StringConstructor)[];
     shadow: import("vue").Prop<boolean | undefined>;
     external: import("vue").Prop<boolean | undefined>;
     underline: import("vue").Prop<boolean | undefined>;
     color: {
         readonly type: StringConstructor;
         readonly default: string | undefined;
+        readonly description: "Theme or CSS color used for the control accents.";
     };
 }>> & Readonly<{}>, {
     tag: string;

package/lib/components/link/Link.vue_vue_type_script_setup_true_lang.js

@@ -10,16 +10,21 @@ var g = {
 	class: "inline-flex items-center"
 }, _ = /* @__PURE__ */ c({
 	name: "XLink",
+	docs: { slots: { default: "Link label and content." } },
 	props: {
 		...e.props("secondary"),
 		tag: {
 			type: String,
-			default: "a"
+			default: "a",
+			description: "Root element tag. Becomes a router-link when `to` is set."
 		},
-		to: [String, Object],
-		shadow: n(),
-		external: n(),
-		underline: n()
+		to: {
+			type: [String, Object],
+			description: "Vue Router location; renders as a link when set."
+		},
+		shadow: n("Inset shadow highlight under the link text."),
+		external: n("Appends an external-link icon after the label."),
+		underline: n("Underlines the link text.")
 	},
 	setup(e) {
 		let { styles: n, classes: c, className: _ } = t("Link", {}, e);

package/lib/components/loader/Loader.vue.d.ts

@@ -4,13 +4,21 @@ declare const loaderProps: {
     status: {
         type: PropType<LoaderStatus>;
         default: string;
+        description: string;
+    };
+    icon: {
+        type: StringConstructor;
+        description: string;
+    };
+    label: {
+        type: StringConstructor;
+        description: string;
     };
-    icon: StringConstructor;
-    label: StringConstructor;
     size: {
         readonly type: PropType<import("../../composables/useCommon").Size>;
         readonly default: "md";
         readonly validator: (value: string) => boolean;
+        readonly description: "Control size. One of xs, sm, md, lg, xl.";
     };
 };
 export type LoaderStatus = 'active' | 'success' | 'error';
@@ -22,25 +30,41 @@ declare const _default: import("vue").DefineComponent<import("vue").ExtractPropT
     status: {
         type: PropType<LoaderStatus>;
         default: string;
+        description: string;
+    };
+    icon: {
+        type: StringConstructor;
+        description: string;
+    };
+    label: {
+        type: StringConstructor;
+        description: string;
     };
-    icon: StringConstructor;
-    label: StringConstructor;
     size: {
         readonly type: PropType<import("../../composables/useCommon").Size>;
         readonly default: "md";
         readonly validator: (value: string) => boolean;
+        readonly description: "Control size. One of xs, sm, md, lg, xl.";
     };
 }>, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
     status: {
         type: PropType<LoaderStatus>;
         default: string;
+        description: string;
+    };
+    icon: {
+        type: StringConstructor;
+        description: string;
+    };
+    label: {
+        type: StringConstructor;
+        description: string;
     };
-    icon: StringConstructor;
-    label: StringConstructor;
     size: {
         readonly type: PropType<import("../../composables/useCommon").Size>;
         readonly default: "md";
         readonly validator: (value: string) => boolean;
+        readonly description: "Control size. One of xs, sm, md, lg, xl.";
     };
 }>> & Readonly<{}>, {
     size: import("../../composables/useCommon").Size;

package/lib/components/loader/Loader.vue_vue_type_script_setup_true_lang.js

@@ -9,10 +9,17 @@ var h = {
 	...t.props(),
 	status: {
 		type: String,
-		default: "active"
+		default: "active",
+		description: "Visual status (active spinner, success, or error)."
 	},
-	icon: String,
-	label: String
+	icon: {
+		type: String,
+		description: "Custom spinner icon when status is `active`."
+	},
+	label: {
+		type: String,
+		description: "Optional text shown next to the status icon."
+	}
 }, g = /* @__PURE__ */ l({
 	name: "XLoader",
 	validators: {
@@ -23,6 +30,7 @@ var h = {
 			"error"
 		]
 	},
+	docs: {},
 	props: h,
 	setup(t) {
 		let { styles: l, classes: h, className: g } = e("Loader", {}, t);