@vuetkit/components 0.0.12 → 0.0.14

package/README.md

@@ -19,3 +19,11 @@ Collection of business development Composable Components for Vue3 + ElementPlus
 ### Table
 
 - [useTable](/components/src/table/useTable/)
+
+### Data
+
+- [useDescriptions](/components/src/data/useDescriptions/)
+
+### Navigation
+
+- [useSteps](/components/src/navigation/useSteps/)

package/dist/index.d.ts

@@ -1,8 +1,23 @@
 import { RequestService } from "@vuetkit/core";
-import { ComponentSize, DialogProps, FormRules, MessageProps, MessageType, PaginationProps, TableProps } from "element-plus";
-import { CSSProperties, Component, MaybeRef, VNode } from "vue";
+import { ComponentSize, DescriptionItemProps, DescriptionProps, DialogProps, FormRules, MessageProps, MessageType, PaginationProps, StepProps, StepsProps, TableProps } from "element-plus";
+import { CSSProperties, Component, MaybeRef, Ref, VNode } from "vue";
 import { TableColumnProps } from "element-plus/es/components/table/src/table-column/defaults.mjs";
 
+//#region src/data/useDescriptions/index.d.ts
+interface DescriptionsColumn extends Partial<DescriptionItemProps> {
+  value?: string;
+  render?: (val: unknown) => VNode;
+  renderLabel?: (val: unknown) => VNode;
+}
+interface DescriptionsOptions<T> extends DescriptionProps {
+  columns: DescriptionsColumn[];
+  service?: RequestService<T>;
+  params?: unknown;
+  formatData?: (data: T) => DescriptionsColumn[];
+}
+type DescriptionsReturnType = [Component];
+declare function useDescriptions<T>(options: DescriptionsOptions<T>): import("vue").DefineSetupFnComponent<Record<string, any>, {}, {}, Record<string, any> & {}, import("vue").PublicProps>[];
+//#endregion
 //#region src/feedback/useAsyncConfirm/index.d.ts
 interface AsyncConfirmOptions {
   title?: string;
@@ -15,7 +30,7 @@ interface AsyncConfirmOptions {
   confirmSuccess?: () => void;
   confirmError?: (error: unknown) => void;
 }
-declare function useAsyncConfirm(confirmService: RequestService, options: AsyncConfirmOptions): {
+declare function useAsyncConfirm<T>(confirmService: RequestService<T>, options: AsyncConfirmOptions): {
   loading: import("vue").Ref<boolean, boolean>;
   confirm: (params?: unknown) => void;
 };
@@ -90,8 +105,44 @@ declare function setDeepProperty(data: Recordable, propArr: string[], value: unk
 declare function useForm(options: undefined): [null, Recordable];
 declare function useForm<T extends object>(options: FormOptions<T>): FormReturnType<T>;
 //#endregion
+//#region src/navigation/useSteps/index.d.ts
+interface StepsColumn extends Partial<StepProps> {
+  title?: string;
+  description?: string;
+  render?: (val: unknown) => VNode;
+  renderTitle?: (val: unknown) => VNode;
+  renderIcon?: (val: unknown) => VNode;
+}
+interface StepsOptions<T> extends StepsProps {
+  steps: StepsColumn[];
+  service?: RequestService<T>;
+  params?: unknown;
+  formatData?: (data: T) => StepsColumn[];
+  defaultActive?: number;
+}
+type StepsReturnType = [Component, Ref<number>];
+declare function useSteps<T>(options: StepsOptions<T>): (Ref<number, number> | import("vue").DefineComponent<import("vue").ExtractPropTypes<{
+  modelValue: {
+    type: NumberConstructor;
+    default: undefined;
+  };
+}>, () => VNode<import("vue").RendererNode, import("vue").RendererElement, {
+  [key: string]: any;
+}>, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
+  modelValue: {
+    type: NumberConstructor;
+    default: undefined;
+  };
+}>> & Readonly<{}>, {
+  modelValue: number;
+}, {}, {}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>)[];
+//#endregion
 //#region src/table/useTable/index.d.ts
 type DefaultRow = Record<PropertyKey, any>;
+interface PaginationData<T> {
+  data: T[];
+  total: number;
+}
 interface TableColumnOptions<T extends DefaultRow> extends TableColumnProps<T> {
   render?: (row: T) => VNode | string;
   children?: TableColumnOptions<T>[];
@@ -102,7 +153,7 @@ interface PaginationOptions extends Partial<PaginationProps> {
 }
 interface TableOptions<T extends DefaultRow> extends TableProps<T> {
   columns: TableColumnOptions<T>[];
-  service?: RequestService;
+  service?: RequestService<T[] | PaginationData<T>>;
   params?: MaybeRef<unknown> | unknown;
   formatData?: (res: unknown) => T[];
   align?: 'left' | 'center' | 'right';
@@ -114,4 +165,4 @@ interface TableOptions<T extends DefaultRow> extends TableProps<T> {
 type TableReturn = [Component];
 declare function useTable<T extends DefaultRow>(options: TableOptions<T>): TableReturn;
 //#endregion
-export { AsyncConfirmOptions, CustomRender, DefaultComponentKey, FormItemType, FormOptions, FormReturnType, FormRuleFn, FormSchema, PaginationOptions, Recordable, TableColumnOptions, TableOptions, TableReturn, setDeepProperty, useAsyncConfirm, useDialog, useForm, useMessage, useTable };
+export { AsyncConfirmOptions, CustomRender, DefaultComponentKey, DescriptionsColumn, DescriptionsOptions, DescriptionsReturnType, FormItemType, FormOptions, FormReturnType, FormRuleFn, FormSchema, PaginationOptions, Recordable, StepsColumn, StepsOptions, StepsReturnType, TableColumnOptions, TableOptions, TableReturn, setDeepProperty, useAsyncConfirm, useDescriptions, useDialog, useForm, useMessage, useSteps, useTable };

package/dist/index.js

@@ -1,7 +1,55 @@
 import { useRequest } from "@vuetkit/core";
-import { ElButton, ElCascader, ElCheckbox, ElCol, ElColorPicker, ElDatePicker, ElDialog, ElForm, ElFormItem, ElInput, ElInputNumber, ElInputOtp, ElMention, ElMessage, ElMessageBox, ElPagination, ElRadio, ElRate, ElRow, ElScrollbar, ElSelect, ElSelectV2, ElSlider, ElSwitch, ElTable, ElTableColumn, ElTimePicker, ElTimeSelect, ElTransfer, ElTreeSelect, ElUpload, vLoading } from "element-plus";
+import { ElButton, ElCascader, ElCheckbox, ElCol, ElColorPicker, ElDatePicker, ElDescriptions, ElDescriptionsItem, ElDialog, ElForm, ElFormItem, ElInput, ElInputNumber, ElInputOtp, ElMention, ElMessage, ElMessageBox, ElPagination, ElRadio, ElRate, ElRow, ElScrollbar, ElSelect, ElSelectV2, ElSlider, ElStep, ElSteps, ElSwitch, ElTable, ElTableColumn, ElTimePicker, ElTimeSelect, ElTransfer, ElTreeSelect, ElUpload, vLoading } from "element-plus";
 import { computed, defineComponent, h, nextTick, onMounted, reactive, ref, toValue, useTemplateRef, watch, withDirectives } from "vue";
 import { isFunc, realObj } from "@vuetkit/shared";
+//#region src/data/useDescriptions/index.ts
+function useDescriptions(options) {
+	const { columns = [], service, params, formatData, ...rest } = options;
+	const { data, loading } = service ? useRequest(service, {
+		defaultParams: params,
+		formatData: formatData || void 0
+	}) : {};
+	const descriptionsColumns = computed(() => (data === null || data === void 0 ? void 0 : data.value) || columns);
+	return [defineComponent((props, { slots }) => {
+		const renderColumns = () => {
+			var _descriptionsColumns$;
+			return (_descriptionsColumns$ = descriptionsColumns.value) === null || _descriptionsColumns$ === void 0 ? void 0 : _descriptionsColumns$.map((item) => {
+				return h(ElDescriptionsItem, { ...item }, {
+					default: () => {
+						if (item === null || item === void 0 ? void 0 : item.render) return item.render(item === null || item === void 0 ? void 0 : item.value);
+						return (item === null || item === void 0 ? void 0 : item.value) || "";
+					},
+					label: () => {
+						var _item$renderLabel;
+						return item === null || item === void 0 || (_item$renderLabel = item.renderLabel) === null || _item$renderLabel === void 0 ? void 0 : _item$renderLabel.call(item, item.label);
+					}
+				});
+			});
+		};
+		return () => {
+			var _loading$value;
+			return withDirectives(h(ElDescriptions, {
+				...rest,
+				...props
+			}, {
+				default: () => {
+					if (slots.default) return slots.default();
+					if (!descriptionsColumns.value.length) return "";
+					return renderColumns();
+				},
+				title: () => {
+					var _slots$title;
+					return (_slots$title = slots.title) === null || _slots$title === void 0 ? void 0 : _slots$title.call(slots);
+				},
+				extra: () => {
+					var _slots$extra;
+					return (_slots$extra = slots.extra) === null || _slots$extra === void 0 ? void 0 : _slots$extra.call(slots);
+				}
+			}), [[vLoading, (_loading$value = loading === null || loading === void 0 ? void 0 : loading.value) !== null && _loading$value !== void 0 ? _loading$value : false]]);
+		};
+	})];
+}
+//#endregion
 //#region src/feedback/useMessage/index.ts
 const DEFAULT_DURATION = 3e3;
 const DEFAULT_SHOW_CLOSE = true;
@@ -316,6 +364,54 @@ function useForm(options) {
 	}];
 }
 //#endregion
+//#region src/navigation/useSteps/index.ts
+function useSteps(options) {
+	const { steps = [], service, params, formatData, defaultActive = 0, ...rest } = options;
+	const { data, loading } = service ? useRequest(service, {
+		defaultParams: params,
+		formatData: formatData || void 0
+	}) : {};
+	const active = ref(defaultActive);
+	const stepsColumns = computed(() => (data === null || data === void 0 ? void 0 : data.value) || steps);
+	return [defineComponent({
+		props: { modelValue: {
+			type: Number,
+			default: void 0
+		} },
+		setup(props, { slots }) {
+			const renderSteps = () => {
+				var _stepsColumns$value;
+				return (_stepsColumns$value = stepsColumns.value) === null || _stepsColumns$value === void 0 ? void 0 : _stepsColumns$value.map((item) => {
+					return h(ElStep, { ...item }, {
+						description: () => {
+							if (item === null || item === void 0 ? void 0 : item.render) return item.render(item === null || item === void 0 ? void 0 : item.description);
+							return (item === null || item === void 0 ? void 0 : item.description) || "";
+						},
+						title: (item === null || item === void 0 ? void 0 : item.renderTitle) ? () => item.renderTitle(item.title) : void 0,
+						icon: (item === null || item === void 0 ? void 0 : item.renderIcon) ? () => item.renderIcon(item.icon) : void 0
+					});
+				});
+			};
+			return () => {
+				var _ref, _props$modelValue, _loading$value;
+				const finalActive = (_ref = (_props$modelValue = props.modelValue) !== null && _props$modelValue !== void 0 ? _props$modelValue : rest.active) !== null && _ref !== void 0 ? _ref : active.value;
+				return withDirectives(h(ElSteps, {
+					...rest,
+					...props,
+					"active": finalActive,
+					"onUpdate:active": (val) => {
+						active.value = val;
+					}
+				}, { default: () => {
+					if (slots.default) return slots.default();
+					if (!stepsColumns.value.length) return "";
+					return renderSteps();
+				} }), [[vLoading, (_loading$value = loading === null || loading === void 0 ? void 0 : loading.value) !== null && _loading$value !== void 0 ? _loading$value : false]]);
+			};
+		}
+	}), active];
+}
+//#endregion
 //#region src/table/useTable/index.ts
 function useTable(options) {
 	const { columns = [], service, params, formatData, align, headerAlign, paginationConfig, searchFormConfig, tableWrapStyle = {}, data = [], ...rest } = options;
@@ -464,4 +560,4 @@ function useTable(options) {
 	})];
 }
 //#endregion
-export { setDeepProperty, useAsyncConfirm, useDialog, useForm, useMessage, useTable };
+export { setDeepProperty, useAsyncConfirm, useDescriptions, useDialog, useForm, useMessage, useSteps, useTable };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@vuetkit/components",
   "type": "module",
-  "version": "0.0.12",
+  "version": "0.0.14",
   "description": "Collection of business development components for Vue3 projects",
   "author": "Kalu5",
   "license": "MIT",
@@ -21,8 +21,8 @@
     "vue": "^3.5.35"
   },
   "dependencies": {
-    "@vuetkit/core": "0.0.12",
-    "@vuetkit/shared": "0.0.12"
+    "@vuetkit/core": "0.0.14",
+    "@vuetkit/shared": "0.0.14"
   },
   "scripts": {
     "build": "tsdown --config-loader tsx"