@indielayer/ui 2.0.0 → 2.1.0

package/lib/components/notifications/Notifications.vue_vue_type_script_setup_true_lang.js

@@ -15,32 +15,39 @@ var O = ["onMouseenter", "onMouseleave"], k = { class: "flex items-center flex-w
 	align: {
 		type: String,
 		default: "right",
-		validator: (e) => N.align.includes(e)
+		validator: (e) => N.align.includes(e),
+		description: "Horizontal placement of the toast stack (left or right)."
 	},
 	position: {
 		type: String,
 		default: "bottom",
-		validator: (e) => N.position.includes(e)
+		validator: (e) => N.position.includes(e),
+		description: "Vertical placement of the toast stack (top or bottom)."
 	},
 	timeout: {
 		type: Number,
-		default: 3500
+		default: 3500,
+		description: "Default auto-dismiss delay in milliseconds. Set 0 to keep until removed."
 	},
 	removable: {
 		type: Boolean,
-		default: !0
+		default: !0,
+		description: "Shows a dismiss control on each notification by default."
 	},
 	pauseOnHover: {
 		type: Boolean,
-		default: !0
+		default: !0,
+		description: "Pauses the dismiss timer while the pointer hovers a notification."
 	},
 	injectKey: {
 		type: [Symbol, String],
-		default: e
+		default: e,
+		description: "Provide/inject key for notification helpers (log, info, success, warn, error)."
 	},
 	offset: {
 		type: [String, Number],
-		default: 0
+		default: 0,
+		description: "Extra inset from the viewport edge in pixels."
 	}
 }, N = {
 	align: ["left", "right"],
@@ -48,6 +55,17 @@ var O = ["onMouseenter", "onMouseleave"], k = { class: "flex items-center flex-w
 }, P = /* @__PURE__ */ g({
 	name: "XNotifications",
 	validators: N,
+	docs: {
+		slots: { default: "App content that can inject notification helpers." },
+		methods: {
+			log: "Show a plain notification.",
+			info: "Show an info-styled notification.",
+			success: "Show a success-styled notification.",
+			warn: "Show a warning-styled notification.",
+			warning: "Alias of `warn`.",
+			error: "Show an error-styled notification."
+		}
+	},
 	props: M,
 	setup(e, { expose: g }) {
 		let M = e, N = x(M.align), P = x(M.position), F = x([]), I = x(null), L = n("notification"), R = t();
@@ -171,6 +189,7 @@ var O = ["onMouseenter", "onMouseleave"], k = { class: "flex items-center flex-w
 			class: _([
 				T(Q),
 				T(Z).wrapper,
+				"pointer-events-none",
 				{
 					"left-0": N.value === "left",
 					"right-0": N.value === "right",
@@ -181,7 +200,11 @@ var O = ["onMouseenter", "onMouseleave"], k = { class: "flex items-center flex-w
 		}, [h(l, {
 			tag: "ul",
 			style: v([P.value === "bottom" ? `padding-bottom: ${Y.value};` : `padding-top: ${Y.value};`]),
-			class: _([T(Z).list, { "flex-col-reverse": P.value }]),
+			class: _([
+				T(Z).list,
+				"pointer-events-none",
+				{ "flex-col-reverse": P.value }
+			]),
 			"enter-active-class": "transition ease-out duration-200",
 			"leave-active-class": "transition ease-out duration-100",
 			"enter-from-class": "transform translate-y-2 opacity-0",
@@ -192,10 +215,14 @@ var O = ["onMouseenter", "onMouseleave"], k = { class: "flex items-center flex-w
 		}, {
 			default: D(() => [(y(!0), p(s, null, S(F.value, (e) => (y(), p("li", {
 				key: e.id,
-				class: _([T(Z).item, {
-					"mb-2": P.value === "bottom",
-					"mt-2": P.value === "top"
-				}]),
+				class: _([
+					T(Z).item,
+					"pointer-events-auto",
+					{
+						"mb-2": P.value === "bottom",
+						"mt-2": P.value === "top"
+					}
+				]),
 				style: v(e.style),
 				onMouseenter: (t) => q(e),
 				onMouseleave: (t) => J(e)

package/lib/components/pagination/Pagination.vue.d.ts

@@ -6,19 +6,23 @@ declare const paginationProps: {
     totalPages: {
         type: NumberConstructor;
         default: number;
+        description: string;
     };
     modelValue: {
         type: NumberConstructor;
         default: number;
+        description: string;
     };
     variant: {
         type: PropType<"dots" | "simple" | "quick">;
         default: string;
+        description: string;
     };
     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 PaginationVariant = typeof paginationVariant[number];
@@ -31,38 +35,46 @@ declare const _default: import("vue").DefineComponent<import("vue").ExtractPropT
     totalPages: {
         type: NumberConstructor;
         default: number;
+        description: string;
     };
     modelValue: {
         type: NumberConstructor;
         default: number;
+        description: string;
     };
     variant: {
         type: PropType<"dots" | "simple" | "quick">;
         default: string;
+        description: string;
     };
     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, "update:modelValue"[], "update:modelValue", import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
     links: import("vue").Prop<boolean | undefined>;
     totalPages: {
         type: NumberConstructor;
         default: number;
+        description: string;
     };
     modelValue: {
         type: NumberConstructor;
         default: number;
+        description: string;
     };
     variant: {
         type: PropType<"dots" | "simple" | "quick">;
         default: string;
+        description: string;
     };
     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<{
     "onUpdate:modelValue"?: ((...args: any[]) => any) | undefined;

package/lib/components/pagination/Pagination.vue_vue_type_script_setup_true_lang.js

@@ -14,18 +14,21 @@ var D = { class: "mx-9 flex items-center" }, O = { class: "text-secondary-600 ml
 	"dots"
 ], j = {
 	...n.props(),
-	links: t(),
+	links: t("Renders page buttons as links (`?page=` query)."),
 	totalPages: {
 		type: Number,
-		default: 1
+		default: 1,
+		description: "Total number of pages."
 	},
 	modelValue: {
 		type: Number,
-		default: 1
+		default: 1,
+		description: "Current page (v-model)."
 	},
 	variant: {
 		type: String,
-		default: "simple"
+		default: "simple",
+		description: "Layout style (simple, quick, or dots)."
 	}
 }, M = /* @__PURE__ */ _({
 	name: "XPagination",
@@ -33,6 +36,7 @@ var D = { class: "mx-9 flex items-center" }, O = { class: "text-secondary-600 ml
 		...n.validators(),
 		variant: A
 	},
+	docs: { emits: { "update:modelValue": "Emitted when the current page changes (v-model)." } },
 	props: j,
 	emits: ["update:modelValue"],
 	setup(t, { emit: n }) {

package/lib/components/pagination/PaginationItem.vue.d.ts

@@ -4,13 +4,18 @@ declare const paginationItemProps: {
     value: {
         type: NumberConstructor;
         default: number;
+        description: string;
+    };
+    selected: {
+        type: BooleanConstructor;
+        description: string;
     };
-    selected: BooleanConstructor;
     links: import("vue").Prop<boolean | undefined>;
     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 PaginationItemProps = ExtractPublicPropTypes<typeof paginationItemProps>;
@@ -21,25 +26,35 @@ declare const _default: import("vue").DefineComponent<import("vue").ExtractPropT
     value: {
         type: NumberConstructor;
         default: number;
+        description: string;
+    };
+    selected: {
+        type: BooleanConstructor;
+        description: string;
     };
-    selected: BooleanConstructor;
     links: import("vue").Prop<boolean | undefined>;
     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, "input"[], "input", import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
     value: {
         type: NumberConstructor;
         default: number;
+        description: string;
+    };
+    selected: {
+        type: BooleanConstructor;
+        description: string;
     };
-    selected: BooleanConstructor;
     links: import("vue").Prop<boolean | undefined>;
     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<{
     onInput?: ((...args: any[]) => any) | undefined;

package/lib/components/pagination/PaginationItem.vue_vue_type_script_setup_true_lang.js

@@ -8,13 +8,18 @@ var m = {
 	...n.props(),
 	value: {
 		type: Number,
-		default: 0
+		default: 0,
+		description: "Page number shown on the control."
 	},
-	selected: Boolean,
-	links: t()
+	selected: {
+		type: Boolean,
+		description: "Marks this page as the current selection."
+	},
+	links: t("Renders as a link to `?page=` instead of a button.")
 }, h = /* @__PURE__ */ s({
 	name: "XPaginationItem",
 	validators: { ...n.validators() },
+	docs: { emits: { input: "Emitted with the page number when an unselected item is clicked." } },
 	props: m,
 	emits: ["input"],
 	setup(t) {

package/lib/components/popover/Popover.vue.d.ts

@@ -4,11 +4,18 @@ import { type Placement, type TriggerEvent } from 'floating-vue';
 export type PopoverPlacement = Placement;
 export type PopoverTriggerEvent = TriggerEvent;
 declare const popoverProps: {
-    disabled: BooleanConstructor;
-    positioningDisabled: BooleanConstructor;
+    disabled: {
+        type: BooleanConstructor;
+        description: string;
+    };
+    positioningDisabled: {
+        type: BooleanConstructor;
+        description: string;
+    };
     placement: {
         type: PropType<Placement>;
         default: string;
+        description: string;
     };
     delay: {
         type: PropType<string | number | {
@@ -16,55 +23,108 @@ declare const popoverProps: {
             hide: number;
         }>;
         default: number;
+        description: string;
+    };
+    distance: {
+        type: (StringConstructor | NumberConstructor)[];
+        description: string;
+    };
+    skidding: {
+        type: (StringConstructor | NumberConstructor)[];
+        description: string;
     };
-    distance: (StringConstructor | NumberConstructor)[];
-    skidding: (StringConstructor | NumberConstructor)[];
     triggers: {
         type: PropType<TriggerEvent[]>;
         default: () => string[];
+        description: string;
     };
     hideArrow: {
         type: BooleanConstructor;
         default: boolean;
+        description: string;
+    };
+    showTriggers: {
+        type: PropType<TriggerEvent[] | ((triggers: Array<PopoverTriggerEvent>) => Array<PopoverTriggerEvent>)>;
+        description: string;
+    };
+    hideTriggers: {
+        type: PropType<TriggerEvent[] | ((triggers: Array<PopoverTriggerEvent>) => Array<PopoverTriggerEvent>)>;
+        description: string;
+    };
+    popperTriggers: {
+        type: PropType<TriggerEvent[]>;
+        description: string;
+    };
+    popperShowTriggers: {
+        type: PropType<TriggerEvent[] | ((triggers: Array<PopoverTriggerEvent>) => Array<PopoverTriggerEvent>)>;
+        description: string;
+    };
+    popperHideTriggers: {
+        type: PropType<TriggerEvent[] | ((triggers: Array<PopoverTriggerEvent>) => Array<PopoverTriggerEvent>)>;
+        description: string;
     };
-    showTriggers: PropType<TriggerEvent[] | ((triggers: Array<PopoverTriggerEvent>) => Array<PopoverTriggerEvent>)>;
-    hideTriggers: PropType<TriggerEvent[] | ((triggers: Array<PopoverTriggerEvent>) => Array<PopoverTriggerEvent>)>;
-    popperTriggers: PropType<TriggerEvent[]>;
-    popperShowTriggers: PropType<TriggerEvent[] | ((triggers: Array<PopoverTriggerEvent>) => Array<PopoverTriggerEvent>)>;
-    popperHideTriggers: PropType<TriggerEvent[] | ((triggers: Array<PopoverTriggerEvent>) => Array<PopoverTriggerEvent>)>;
     container: {
         type: (BooleanConstructor | ObjectConstructor | StringConstructor)[];
         default: string;
+        description: string;
+    };
+    boundary: {
+        type: (ObjectConstructor | StringConstructor)[];
+        description: string;
     };
-    boundary: (ObjectConstructor | StringConstructor)[];
     strategy: {
         type: PropType<"absolute" | "fixed">;
         default: string;
+        description: string;
     };
     autoHide: {
         type: PropType<boolean | ((event: Event) => boolean)>;
         default: boolean;
+        description: string;
+    };
+    shown: {
+        type: BooleanConstructor;
+        description: string;
     };
-    shown: BooleanConstructor;
     handleResize: {
         type: BooleanConstructor;
         default: boolean;
+        description: string;
+    };
+    instantMove: {
+        type: BooleanConstructor;
+        description: string;
+    };
+    eagerMount: {
+        type: BooleanConstructor;
+        description: string;
+    };
+    popperClass: {
+        type: (ArrayConstructor | ObjectConstructor | StringConstructor)[];
+        description: string;
+    };
+    computeTransformOrigin: {
+        type: BooleanConstructor;
+        description: string;
     };
-    instantMove: BooleanConstructor;
-    eagerMount: BooleanConstructor;
-    popperClass: (ArrayConstructor | ObjectConstructor | StringConstructor)[];
-    computeTransformOrigin: BooleanConstructor;
 };
 export type PopoverProps = ExtractPublicPropTypes<typeof popoverProps>;
 type InternalClasses = 'wrapper' | 'content';
 export interface PopoverTheme extends ThemeComponent<PopoverProps, InternalClasses> {
 }
 declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<import("vue").ExtractPropTypes<{
-    disabled: BooleanConstructor;
-    positioningDisabled: BooleanConstructor;
+    disabled: {
+        type: BooleanConstructor;
+        description: string;
+    };
+    positioningDisabled: {
+        type: BooleanConstructor;
+        description: string;
+    };
     placement: {
         type: PropType<Placement>;
         default: string;
+        description: string;
     };
     delay: {
         type: PropType<string | number | {
@@ -72,55 +132,108 @@ declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<im
             hide: number;
         }>;
         default: number;
+        description: string;
+    };
+    distance: {
+        type: (StringConstructor | NumberConstructor)[];
+        description: string;
+    };
+    skidding: {
+        type: (StringConstructor | NumberConstructor)[];
+        description: string;
     };
-    distance: (StringConstructor | NumberConstructor)[];
-    skidding: (StringConstructor | NumberConstructor)[];
     triggers: {
         type: PropType<TriggerEvent[]>;
         default: () => string[];
+        description: string;
     };
     hideArrow: {
         type: BooleanConstructor;
         default: boolean;
+        description: string;
+    };
+    showTriggers: {
+        type: PropType<TriggerEvent[] | ((triggers: TriggerEvent[]) => TriggerEvent[])>;
+        description: string;
+    };
+    hideTriggers: {
+        type: PropType<TriggerEvent[] | ((triggers: TriggerEvent[]) => TriggerEvent[])>;
+        description: string;
+    };
+    popperTriggers: {
+        type: PropType<TriggerEvent[]>;
+        description: string;
+    };
+    popperShowTriggers: {
+        type: PropType<TriggerEvent[] | ((triggers: TriggerEvent[]) => TriggerEvent[])>;
+        description: string;
+    };
+    popperHideTriggers: {
+        type: PropType<TriggerEvent[] | ((triggers: TriggerEvent[]) => TriggerEvent[])>;
+        description: string;
     };
-    showTriggers: PropType<TriggerEvent[] | ((triggers: TriggerEvent[]) => TriggerEvent[])>;
-    hideTriggers: PropType<TriggerEvent[] | ((triggers: TriggerEvent[]) => TriggerEvent[])>;
-    popperTriggers: PropType<TriggerEvent[]>;
-    popperShowTriggers: PropType<TriggerEvent[] | ((triggers: TriggerEvent[]) => TriggerEvent[])>;
-    popperHideTriggers: PropType<TriggerEvent[] | ((triggers: TriggerEvent[]) => TriggerEvent[])>;
     container: {
         type: (BooleanConstructor | ObjectConstructor | StringConstructor)[];
         default: string;
+        description: string;
+    };
+    boundary: {
+        type: (ObjectConstructor | StringConstructor)[];
+        description: string;
     };
-    boundary: (ObjectConstructor | StringConstructor)[];
     strategy: {
         type: PropType<"absolute" | "fixed">;
         default: string;
+        description: string;
     };
     autoHide: {
         type: PropType<boolean | ((event: Event) => boolean)>;
         default: boolean;
+        description: string;
+    };
+    shown: {
+        type: BooleanConstructor;
+        description: string;
     };
-    shown: BooleanConstructor;
     handleResize: {
         type: BooleanConstructor;
         default: boolean;
+        description: string;
+    };
+    instantMove: {
+        type: BooleanConstructor;
+        description: string;
+    };
+    eagerMount: {
+        type: BooleanConstructor;
+        description: string;
+    };
+    popperClass: {
+        type: (ArrayConstructor | ObjectConstructor | StringConstructor)[];
+        description: string;
+    };
+    computeTransformOrigin: {
+        type: BooleanConstructor;
+        description: string;
     };
-    instantMove: BooleanConstructor;
-    eagerMount: BooleanConstructor;
-    popperClass: (ArrayConstructor | ObjectConstructor | StringConstructor)[];
-    computeTransformOrigin: BooleanConstructor;
 }>, {
     show: () => void;
     hide: () => void;
     toggle: () => void;
     isOpen: import("vue").Ref<boolean, boolean>;
 }, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, ("resize" | "show" | "hide" | "update:shown" | "apply-show" | "apply-hide" | "close-group" | "close-directive" | "auto-hide")[], "resize" | "show" | "hide" | "update:shown" | "apply-show" | "apply-hide" | "close-group" | "close-directive" | "auto-hide", import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
-    disabled: BooleanConstructor;
-    positioningDisabled: BooleanConstructor;
+    disabled: {
+        type: BooleanConstructor;
+        description: string;
+    };
+    positioningDisabled: {
+        type: BooleanConstructor;
+        description: string;
+    };
     placement: {
         type: PropType<Placement>;
         default: string;
+        description: string;
     };
     delay: {
         type: PropType<string | number | {
@@ -128,44 +241,90 @@ declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<im
             hide: number;
         }>;
         default: number;
+        description: string;
+    };
+    distance: {
+        type: (StringConstructor | NumberConstructor)[];
+        description: string;
+    };
+    skidding: {
+        type: (StringConstructor | NumberConstructor)[];
+        description: string;
     };
-    distance: (StringConstructor | NumberConstructor)[];
-    skidding: (StringConstructor | NumberConstructor)[];
     triggers: {
         type: PropType<TriggerEvent[]>;
         default: () => string[];
+        description: string;
     };
     hideArrow: {
         type: BooleanConstructor;
         default: boolean;
+        description: string;
+    };
+    showTriggers: {
+        type: PropType<TriggerEvent[] | ((triggers: TriggerEvent[]) => TriggerEvent[])>;
+        description: string;
+    };
+    hideTriggers: {
+        type: PropType<TriggerEvent[] | ((triggers: TriggerEvent[]) => TriggerEvent[])>;
+        description: string;
+    };
+    popperTriggers: {
+        type: PropType<TriggerEvent[]>;
+        description: string;
+    };
+    popperShowTriggers: {
+        type: PropType<TriggerEvent[] | ((triggers: TriggerEvent[]) => TriggerEvent[])>;
+        description: string;
+    };
+    popperHideTriggers: {
+        type: PropType<TriggerEvent[] | ((triggers: TriggerEvent[]) => TriggerEvent[])>;
+        description: string;
     };
-    showTriggers: PropType<TriggerEvent[] | ((triggers: TriggerEvent[]) => TriggerEvent[])>;
-    hideTriggers: PropType<TriggerEvent[] | ((triggers: TriggerEvent[]) => TriggerEvent[])>;
-    popperTriggers: PropType<TriggerEvent[]>;
-    popperShowTriggers: PropType<TriggerEvent[] | ((triggers: TriggerEvent[]) => TriggerEvent[])>;
-    popperHideTriggers: PropType<TriggerEvent[] | ((triggers: TriggerEvent[]) => TriggerEvent[])>;
     container: {
         type: (BooleanConstructor | ObjectConstructor | StringConstructor)[];
         default: string;
+        description: string;
+    };
+    boundary: {
+        type: (ObjectConstructor | StringConstructor)[];
+        description: string;
     };
-    boundary: (ObjectConstructor | StringConstructor)[];
     strategy: {
         type: PropType<"absolute" | "fixed">;
         default: string;
+        description: string;
     };
     autoHide: {
         type: PropType<boolean | ((event: Event) => boolean)>;
         default: boolean;
+        description: string;
+    };
+    shown: {
+        type: BooleanConstructor;
+        description: string;
     };
-    shown: BooleanConstructor;
     handleResize: {
         type: BooleanConstructor;
         default: boolean;
+        description: string;
+    };
+    instantMove: {
+        type: BooleanConstructor;
+        description: string;
+    };
+    eagerMount: {
+        type: BooleanConstructor;
+        description: string;
+    };
+    popperClass: {
+        type: (ArrayConstructor | ObjectConstructor | StringConstructor)[];
+        description: string;
+    };
+    computeTransformOrigin: {
+        type: BooleanConstructor;
+        description: string;
     };
-    instantMove: BooleanConstructor;
-    eagerMount: BooleanConstructor;
-    popperClass: (ArrayConstructor | ObjectConstructor | StringConstructor)[];
-    computeTransformOrigin: BooleanConstructor;
 }>> & Readonly<{
     onResize?: ((...args: any[]) => any) | undefined;
     onShow?: ((...args: any[]) => any) | undefined;