@indielayer/ui 2.0.0 → 2.1.0

package/lib/components/formGroup/FormGroup.vue.d.ts

@@ -4,35 +4,79 @@ declare const formGroupProps: {
     vertical: {
         type: BooleanConstructor;
         default: boolean;
+        description: string;
     };
     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).";
     };
 };
 export type FormGroupProps = ExtractPublicPropTypes<typeof formGroupProps>;
@@ -61,35 +105,79 @@ declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<im
     vertical: {
         type: BooleanConstructor;
         default: boolean;
+        description: string;
     };
     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).";
     };
 }>, {
     focus: () => void;
@@ -101,35 +189,79 @@ declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<im
     vertical: {
         type: BooleanConstructor;
         default: boolean;
+        description: string;
     };
     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).";
     };
 }>> & Readonly<{
     [x: `on${Capitalize<string>}`]: ((...args: any[]) => any) | undefined;

package/lib/components/formGroup/FormGroup.vue_vue_type_script_setup_true_lang.js

@@ -6,16 +6,22 @@ import i from "../inputFooter/InputFooter.js";
 import a from "../label/Label.js";
 import { computed as o, createBlock as s, createCommentVNode as c, createElementVNode as l, defineComponent as u, mergeProps as d, normalizeClass as f, openBlock as p, provide as m, ref as h, renderSlot as g, toHandlers as _, unref as v, withCtx as y, withKeys as b } from "vue";
 //#region src/components/formGroup/FormGroup.vue?vue&type=script&setup=true&lang.ts
-var x = /* @__PURE__ */ u({
+var x = {
+	...n.props(),
+	...r.props(),
+	vertical: {
+		type: Boolean,
+		default: !1,
+		description: "Stacks child controls vertically instead of in a row."
+	}
+}, S = /* @__PURE__ */ u({
 	name: "XFormGroup",
-	props: {
-		...n.props(),
-		...r.props(),
-		vertical: {
-			type: Boolean,
-			default: !1
-		}
+	docs: {
+		slots: { default: "Grouped inputs (radios, checkboxes, radio buttons, etc.)." },
+		emits: { ...r.emitDocs() },
+		methods: { ...r.methodDocs() }
 	},
+	props: x,
 	emits: r.emits(),
 	setup(n, { expose: u, emit: x }) {
 		let S = n, C = [], w = h(0), T = o(() => w.value > 0);
@@ -88,4 +94,4 @@ var x = /* @__PURE__ */ u({
 	}
 });
 //#endregion
-export { x as default };
+export { S as default };

package/lib/components/icon/Icon.vue.d.ts

@@ -4,16 +4,19 @@ declare const iconProps: {
     icon: {
         type: StringConstructor;
         required: boolean;
+        description: string;
     };
     filled: import("vue").Prop<boolean | undefined>;
     viewBox: {
         type: StringConstructor;
         default: string;
+        description: string;
     };
     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 IconProps = ExtractPublicPropTypes<typeof iconProps>;
@@ -30,31 +33,37 @@ declare const _default: import("vue").DefineComponent<import("vue").ExtractPropT
     icon: {
         type: StringConstructor;
         required: boolean;
+        description: string;
     };
     filled: import("vue").Prop<boolean | undefined>;
     viewBox: {
         type: StringConstructor;
         default: string;
+        description: string;
     };
     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<{
     icon: {
         type: StringConstructor;
         required: boolean;
+        description: string;
     };
     filled: import("vue").Prop<boolean | undefined>;
     viewBox: {
         type: StringConstructor;
         default: string;
+        description: string;
     };
     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<{}>, {
     size: import("../../composables/useCommon").Size;

package/lib/components/icon/Icon.vue_vue_type_script_setup_true_lang.js

@@ -15,16 +15,19 @@ var h = ["innerHTML"], g = [
 	...r.props(),
 	icon: {
 		type: String,
-		required: !0
+		required: !0,
+		description: "Icon name from the injected icon set, or raw SVG path markup."
 	},
-	filled: n(),
+	filled: n("Renders a filled icon instead of an outline stroke."),
 	viewBox: {
 		type: String,
-		default: "0 0 24 24"
+		default: "0 0 24 24",
+		description: "SVG viewBox when rendering path markup."
 	}
 }, v = /* @__PURE__ */ o({
 	name: "XIcon",
 	validators: { ...r.validators() },
+	docs: {},
 	props: _,
 	setup(n) {
 		let r = n, o = s(e, {}), _ = f(!1), v = f(""), y = f(r.filled), b = f(r.viewBox), x = f({});

package/lib/components/image/Image.vue.d.ts

@@ -1,15 +1,24 @@
 import { type ExtractPublicPropTypes } from 'vue';
 import { type ThemeComponent } from '../../composables/useTheme';
 declare const imageProps: {
-    src: StringConstructor;
+    src: {
+        type: StringConstructor;
+        description: string;
+    };
 };
 export type ImageProps = ExtractPublicPropTypes<typeof imageProps>;
 type InternalClasses = 'wrapper';
 export interface ImageTheme extends ThemeComponent<ImageProps, InternalClasses> {
 }
 declare const _default: import("vue").DefineComponent<import("vue").ExtractPropTypes<{
-    src: StringConstructor;
+    src: {
+        type: StringConstructor;
+        description: string;
+    };
 }>, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
-    src: StringConstructor;
+    src: {
+        type: StringConstructor;
+        description: string;
+    };
 }>> & Readonly<{}>, {}, {}, {}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>;
 export default _default;

package/lib/components/image/Image.vue_vue_type_script_setup_true_lang.js

@@ -3,7 +3,11 @@ import { createElementBlock as t, defineComponent as n, normalizeClass as r, nor
 //#region src/components/image/Image.vue?vue&type=script&setup=true&lang.ts
 var l = ["src"], u = /* @__PURE__ */ n({
 	name: "XImage",
-	props: { src: String },
+	docs: {},
+	props: { src: {
+		type: String,
+		description: "Image URL. Shows a transparent placeholder until the image loads."
+	} },
 	setup(n) {
 		let u = n, d = o("data:image/gif;base64,R0lGODlhAQABAAD/ACwAAAAAAQABAAACADs=");
 		typeof window < "u" && Image && c(() => u.src, (e) => {

package/lib/components/index.js

@@ -9,15 +9,15 @@ import s from "./link/Link.js";
 import c from "./breadcrumbs/Breadcrumbs.js";
 import l from "./spinner/Spinner.js";
 import u from "./loader/Loader.js";
-import d from "./button/Button.js";
-import f from "./button/ButtonGroup.js";
-import p from "./card/Card.js";
-import m from "./carousel/Carousel.js";
-import h from "./carousel/CarouselSlide.js";
-import g from "./inputFooter/InputFooter.js";
-import _ from "./checkbox/Checkbox.js";
-import v from "./container/Container.js";
-import y from "./tooltip/Tooltip.js";
+import d from "./tooltip/Tooltip.js";
+import f from "./button/Button.js";
+import p from "./button/ButtonGroup.js";
+import m from "./card/Card.js";
+import h from "./carousel/Carousel.js";
+import g from "./carousel/CarouselSlide.js";
+import _ from "./inputFooter/InputFooter.js";
+import v from "./checkbox/Checkbox.js";
+import y from "./container/Container.js";
 import b from "./tooltip/ToggleTip.js";
 import x from "./label/Label.js";
 import S from "./input/Input.js";
@@ -68,13 +68,13 @@ var ce = /* @__PURE__ */ e({
 	XAvatar: () => a,
 	XBadge: () => o,
 	XBreadcrumbs: () => c,
-	XButton: () => d,
-	XButtonGroup: () => f,
-	XCard: () => p,
-	XCarousel: () => m,
-	XCarouselSlide: () => h,
-	XCheckbox: () => _,
-	XContainer: () => v,
+	XButton: () => f,
+	XButtonGroup: () => p,
+	XCard: () => m,
+	XCarousel: () => h,
+	XCarouselSlide: () => g,
+	XCheckbox: () => v,
+	XContainer: () => y,
 	XDatepicker: () => C,
 	XDivider: () => w,
 	XDrawer: () => E,
@@ -84,7 +84,7 @@ var ce = /* @__PURE__ */ e({
 	XIcon: () => n,
 	XImage: () => A,
 	XInput: () => S,
-	XInputFooter: () => g,
+	XInputFooter: () => _,
 	XInputGroup: () => j,
 	XLabel: () => x,
 	XLink: () => s,
@@ -121,7 +121,7 @@ var ce = /* @__PURE__ */ e({
 	XThemeProvider: () => ae,
 	XToggle: () => oe,
 	XToggleTip: () => b,
-	XTooltip: () => y,
+	XTooltip: () => d,
 	XUpload: () => se
 });
 //#endregion