@indielayer/ui 2.0.0 → 2.1.0

package/lib/components/table/TableRow.vue_vue_type_script_setup_true_lang.js

@@ -12,15 +12,20 @@ var u = { verticalAlign: [
 ] }, d = /* @__PURE__ */ i({
 	name: "XTableRow",
 	validators: u,
+	docs: { slots: { default: "Row cells (`x-table-cell` children)." } },
 	props: {
-		pointer: t(),
-		striped: t(),
-		selected: Boolean,
-		singleSelect: t(),
+		pointer: t("Pointer cursor on the row."),
+		striped: t("Applies striped row styling."),
+		selected: {
+			type: Boolean,
+			description: "Marks the row as selected."
+		},
+		singleSelect: t("Single-select styling for the selected row."),
 		verticalAlign: {
 			type: String,
 			default: "top",
-			validator: (e) => u.verticalAlign.includes(e)
+			validator: (e) => u.verticalAlign.includes(e),
+			description: "Vertical alignment for cells in the row."
 		}
 	},
 	setup(t) {

package/lib/components/tag/Tag.vue.d.ts

@@ -4,21 +4,30 @@ declare const tagProps: {
     tag: {
         type: StringConstructor;
         default: string;
+        description: string;
     };
     rounded: import("vue").Prop<boolean | undefined>;
     removable: import("vue").Prop<boolean | undefined>;
     outlined: import("vue").Prop<boolean | undefined>;
     filled: import("vue").Prop<boolean | undefined>;
-    disabled: BooleanConstructor;
-    to: (ObjectConstructor | StringConstructor)[];
+    disabled: {
+        type: BooleanConstructor;
+        description: string;
+    };
+    to: {
+        type: (ObjectConstructor | StringConstructor)[];
+        description: string;
+    };
     color: {
         readonly type: StringConstructor;
         readonly default: string | undefined;
+        readonly description: "Theme or CSS color used for the control accents.";
     };
     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 TagProps = ExtractPublicPropTypes<typeof tagProps>;
@@ -29,41 +38,59 @@ declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<im
     tag: {
         type: StringConstructor;
         default: string;
+        description: string;
     };
     rounded: import("vue").Prop<boolean | undefined>;
     removable: import("vue").Prop<boolean | undefined>;
     outlined: import("vue").Prop<boolean | undefined>;
     filled: import("vue").Prop<boolean | undefined>;
-    disabled: BooleanConstructor;
-    to: (ObjectConstructor | StringConstructor)[];
+    disabled: {
+        type: BooleanConstructor;
+        description: string;
+    };
+    to: {
+        type: (ObjectConstructor | StringConstructor)[];
+        description: string;
+    };
     color: {
         readonly type: StringConstructor;
         readonly default: string | undefined;
+        readonly description: "Theme or CSS color used for the control accents.";
     };
     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, "remove"[], "remove", import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
     tag: {
         type: StringConstructor;
         default: string;
+        description: string;
     };
     rounded: import("vue").Prop<boolean | undefined>;
     removable: import("vue").Prop<boolean | undefined>;
     outlined: import("vue").Prop<boolean | undefined>;
     filled: import("vue").Prop<boolean | undefined>;
-    disabled: BooleanConstructor;
-    to: (ObjectConstructor | StringConstructor)[];
+    disabled: {
+        type: BooleanConstructor;
+        description: string;
+    };
+    to: {
+        type: (ObjectConstructor | StringConstructor)[];
+        description: string;
+    };
     color: {
         readonly type: StringConstructor;
         readonly default: string | undefined;
+        readonly description: "Theme or CSS color used for the control accents.";
     };
     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<{
     onRemove?: ((...args: any[]) => any) | undefined;

package/lib/components/tag/Tag.vue_vue_type_script_setup_true_lang.js

@@ -15,17 +15,31 @@ var C = { class: "flex items-center gap-2" }, w = { class: "truncate" }, T = {
 	...t.props("secondary"),
 	tag: {
 		type: String,
-		default: "span"
+		default: "span",
+		description: "Root element tag. Becomes an anchor or router-link when `href` or `to` is set."
 	},
-	rounded: r(),
-	removable: r(),
-	outlined: r(),
-	filled: r(),
-	disabled: Boolean,
-	to: [String, Object]
+	rounded: r("Fully rounded corners (pill shape)."),
+	removable: r("Shows a remove control that emits `remove`."),
+	outlined: r("Outline style with a transparent fill."),
+	filled: r("Filled style using the theme color."),
+	disabled: {
+		type: Boolean,
+		description: "Disables the remove control and applies disabled styling."
+	},
+	to: {
+		type: [String, Object],
+		description: "Vue Router location; renders as a link when set."
+	}
 }, D = /* @__PURE__ */ p({
 	name: "XTag",
 	validators: { ...i.validators() },
+	docs: {
+		slots: {
+			default: "Tag label and content.",
+			prefix: "Content shown before the label."
+		},
+		emits: { remove: "Emitted when the remove icon is clicked." }
+	},
 	props: E,
 	emits: ["remove"],
 	setup(t) {

package/lib/components/textarea/Textarea.vue.d.ts

@@ -5,16 +5,33 @@ declare const textareaProps: {
     dir: {
         type: StringConstructor;
         default: string;
+        description: string;
     };
     rows: {
         type: (StringConstructor | NumberConstructor)[];
         default: number;
+        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;
     };
-    max: (StringConstructor | NumberConstructor)[];
-    maxlength: (StringConstructor | NumberConstructor)[];
-    min: (StringConstructor | NumberConstructor)[];
-    minlength: (StringConstructor | NumberConstructor)[];
-    placeholder: StringConstructor;
     adjustToText: import("vue").Prop<boolean | undefined>;
     preventEnter: import("vue").Prop<boolean | undefined>;
     block: import("vue").Prop<boolean | undefined>;
@@ -24,36 +41,80 @@ declare const textareaProps: {
     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 TextareaProps = ExtractPublicPropTypes<typeof textareaProps>;
@@ -69,16 +130,33 @@ declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<im
     dir: {
         type: StringConstructor;
         default: string;
+        description: string;
     };
     rows: {
         type: (StringConstructor | NumberConstructor)[];
         default: number;
+        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;
     };
-    max: (StringConstructor | NumberConstructor)[];
-    maxlength: (StringConstructor | NumberConstructor)[];
-    min: (StringConstructor | NumberConstructor)[];
-    minlength: (StringConstructor | NumberConstructor)[];
-    placeholder: StringConstructor;
     adjustToText: import("vue").Prop<boolean | undefined>;
     preventEnter: import("vue").Prop<boolean | undefined>;
     block: import("vue").Prop<boolean | undefined>;
@@ -88,36 +166,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 | undefined;
@@ -129,16 +251,33 @@ declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<im
     dir: {
         type: StringConstructor;
         default: string;
+        description: string;
     };
     rows: {
         type: (StringConstructor | NumberConstructor)[];
         default: number;
+        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;
     };
-    max: (StringConstructor | NumberConstructor)[];
-    maxlength: (StringConstructor | NumberConstructor)[];
-    min: (StringConstructor | NumberConstructor)[];
-    minlength: (StringConstructor | NumberConstructor)[];
-    placeholder: StringConstructor;
     adjustToText: import("vue").Prop<boolean | undefined>;
     preventEnter: import("vue").Prop<boolean | undefined>;
     block: import("vue").Prop<boolean | undefined>;
@@ -148,36 +287,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/textarea/Textarea.vue_vue_type_script_setup_true_lang.js

@@ -32,26 +32,51 @@ var T = { class: "relative" }, E = [
 	...s.props(),
 	dir: {
 		type: String,
-		default: "ltr"
+		default: "ltr",
+		description: "Text direction for the textarea (`ltr` or `rtl`)."
 	},
 	rows: {
 		type: [Number, String],
-		default: 2
+		default: 2,
+		description: "Visible number of text lines."
 	},
-	max: [Number, String],
-	maxlength: [Number, String],
-	min: [Number, String],
-	minlength: [Number, String],
-	placeholder: String,
-	adjustToText: i(),
-	preventEnter: i(),
-	block: i(),
-	resizable: i(),
-	showCounter: i(),
-	clearable: i()
+	max: {
+		type: [Number, String],
+		description: "Native `max` attribute when applicable."
+	},
+	maxlength: {
+		type: [Number, String],
+		description: "Maximum character length for the value."
+	},
+	min: {
+		type: [Number, String],
+		description: "Native `min` attribute when applicable."
+	},
+	minlength: {
+		type: [Number, String],
+		description: "Minimum character length for the value."
+	},
+	placeholder: {
+		type: String,
+		description: "Placeholder text shown when the value is empty."
+	},
+	adjustToText: i("Auto-grows the height to fit the content."),
+	preventEnter: i("Prevents the Enter key from inserting a newline."),
+	block: i("Stretches to the full width of the parent."),
+	resizable: i("Allows the user to resize the textarea."),
+	showCounter: i("Shows a character counter in the footer."),
+	clearable: i("Shows a clear button when the value is not empty.")
 }, O = /* @__PURE__ */ g({
 	name: "XTextarea",
 	validators: { ...a.validators() },
+	docs: {
+		slots: {
+			prefix: "Content before the textarea (left adornment).",
+			suffix: "Content after the textarea (right adornment)."
+		},
+		emits: { ...s.emitDocs() },
+		methods: { ...s.methodDocs() }
+	},
 	props: D,
 	emits: s.emits(),
 	setup(i, { expose: a, emit: g }) {

package/lib/components/themeProvider/ThemeProvider.vue.d.ts

@@ -1,9 +1,15 @@
-import { type PropType } from 'vue';
-import { type UITheme } from '../../theme';
+import type { PropType } from 'vue';
+import type { UITheme } from '../../theme';
 declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<import("vue").ExtractPropTypes<{
-    theme: PropType<UITheme>;
+    theme: {
+        type: PropType<UITheme>;
+        description: string;
+    };
 }>, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
-    theme: PropType<UITheme>;
+    theme: {
+        type: PropType<UITheme>;
+        description: string;
+    };
 }>> & Readonly<{}>, {}, {}, {}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>, {
     default?(_: {}): any;
 }>;

package/lib/components/themeProvider/ThemeProvider.vue_vue_type_script_setup_true_lang.js

@@ -1,9 +1,14 @@
 import { injectThemeKey as e } from "../../composables/keys.js";
 import { injectThemeStyles as t } from "../../theme.js";
 import { defineComponent as n, inject as r, provide as i, ref as a, renderSlot as o, unref as s, watchEffect as c } from "vue";
+//#region src/components/themeProvider/ThemeProvider.vue?vue&type=script&setup=true&lang.ts
 var l = /* @__PURE__ */ n({
 	name: "XThemeProvider",
-	props: { theme: Object },
+	docs: { slots: { default: "Content that receives the provided theme." } },
+	props: { theme: {
+		type: Object,
+		description: "Theme object provided to descendant components."
+	} },
 	setup(n) {
 		let l = n, u = r(e, {}), d = a(l.theme || s(u) || {});
 		return i(e, d), c(() => {