@vuetkit/components 0.0.9 → 0.0.11

package/README.md

@@ -14,3 +14,7 @@ Collection of business development Composable Components for Vue3 + ElementPlus
 ### Form
 
 - [useForm](/components/src/form/useForm/)
+
+### Table
+
+- [useTable](/components/src/table/useTable/)

package/dist/index.d.ts

@@ -1,6 +1,7 @@
 import { RequestService } from "@vuetkit/core";
-import { ComponentSize, FormRules, MessageProps, MessageType } from "element-plus";
-import { Component } from "vue";
+import { ComponentSize, FormRules, MessageProps, MessageType, PaginationProps, TableProps } from "element-plus";
+import { CSSProperties, Component, MaybeRef, VNode } from "vue";
+import { TableColumnProps } from "element-plus/es/components/table/src/table-column/defaults.mjs";
 
 //#region src/feedback/useAsyncConfirm/index.d.ts
 interface AsyncConfirmOptions {
@@ -76,6 +77,31 @@ type FormReturnType<T extends object> = [Component, {
   setData: (newData: T) => void;
 }];
 declare function setDeepProperty(data: Recordable, propArr: string[], value: unknown): void;
+declare function useForm(options: undefined): [null, Recordable];
 declare function useForm<T extends object>(options: FormOptions<T>): FormReturnType<T>;
 //#endregion
-export { AsyncConfirmOptions, CustomRender, DefaultComponentKey, FormItemType, FormOptions, FormReturnType, FormRuleFn, FormSchema, Recordable, setDeepProperty, useAsyncConfirm, useForm, useMessage };
+//#region src/table/useTable/index.d.ts
+type DefaultRow = Record<PropertyKey, any>;
+interface TableColumnOptions<T extends DefaultRow> extends TableColumnProps<T> {
+  render?: (row: T) => VNode | string;
+  children?: TableColumnOptions<T>[];
+  prop?: string;
+}
+interface PaginationOptions extends Partial<PaginationProps> {
+  wrapStyle?: CSSProperties;
+}
+interface TableOptions<T extends DefaultRow> extends TableProps<T> {
+  columns: TableColumnOptions<T>[];
+  service?: RequestService;
+  params?: MaybeRef<unknown> | unknown;
+  formatData?: (res: unknown) => T[];
+  align?: 'left' | 'center' | 'right';
+  headerAlign?: 'left' | 'center' | 'right';
+  paginationConfig?: boolean | PaginationOptions;
+  tableWrapStyle?: CSSProperties;
+  searchFormConfig?: FormOptions<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, useForm, useMessage, useTable };

package/dist/index.js

@@ -1,7 +1,7 @@
 import { useRequest } from "@vuetkit/core";
-import { ElCascader, ElCheckbox, ElCol, ElColorPicker, ElDatePicker, ElForm, ElFormItem, ElInput, ElInputNumber, ElInputOtp, ElMention, ElMessage, ElMessageBox, ElRadio, ElRate, ElRow, ElSelect, ElSelectV2, ElSlider, ElSwitch, ElTimePicker, ElTimeSelect, ElTransfer, ElTreeSelect, ElUpload } from "element-plus";
-import { isFunc } from "@vuetkit/shared";
-import { computed, defineComponent, h, nextTick, onMounted, ref, useTemplateRef } from "vue";
+import { ElButton, ElCascader, ElCheckbox, ElCol, ElColorPicker, ElDatePicker, ElForm, ElFormItem, ElInput, ElInputNumber, ElInputOtp, ElMention, ElMessage, ElMessageBox, ElPagination, ElRadio, ElRate, ElRow, ElSelect, ElSelectV2, ElSlider, ElSwitch, ElTable, ElTableColumn, ElTimePicker, ElTimeSelect, ElTransfer, ElTreeSelect, ElUpload, vLoading } from "element-plus";
+import { isFunc, realObj } from "@vuetkit/shared";
+import { computed, defineComponent, h, nextTick, onMounted, reactive, ref, toValue, useTemplateRef, watch, withDirectives } from "vue";
 //#region src/feedback/useMessage/index.ts
 const DEFAULT_DURATION = 3e3;
 const DEFAULT_SHOW_CLOSE = true;
@@ -112,7 +112,9 @@ function setDeepProperty(data, propArr, value) {
 	temp[propArr[propArr.length - 1]] = value;
 }
 function useForm(options) {
-	const { schemas = [], rules = {}, colSpan = 24, defaultData, disabled = false, inline = false, size, rowGutter = 20, labelWidth, labelSuffix = "", labelPosition = "left", "validate-on-rule-change": validateOnRuleChange = true, enterCallback, customComponent, "scrollTo-error": scrollToError = false, "scroll-into-view-options": scrollIntoViewOptions = true, "status-icon": statusIcon = false, "require-asterisk-position": requireAsteriskPosition = "left", "show-message": showMessage = true, "inline-message": inlineMessage = false } = options || {};
+	var _options$schemas;
+	if (!options || !((_options$schemas = options.schemas) === null || _options$schemas === void 0 ? void 0 : _options$schemas.length)) return [null, {}];
+	const { schemas = [], rules = {}, colSpan = 24, defaultData, disabled = false, inline = false, size, rowGutter = 20, labelWidth, labelSuffix = "", labelPosition = "left", "validate-on-rule-change": validateOnRuleChange = true, enterCallback, customComponent, "scrollTo-error": scrollToError = false, "scroll-into-view-options": scrollIntoViewOptions = true, "status-icon": statusIcon = false, "require-asterisk-position": requireAsteriskPosition = "left", "show-message": showMessage = true, "inline-message": inlineMessage = false } = options;
 	const components = {};
 	if (customComponent) Object.assign(components, defaultComponent, customComponent);
 	else Object.assign(components, defaultComponent);
@@ -270,4 +272,152 @@ function useForm(options) {
 	}];
 }
 //#endregion
-export { setDeepProperty, useAsyncConfirm, useForm, useMessage };
+//#region src/table/useTable/index.ts
+function useTable(options) {
+	const { columns = [], service, params, formatData, align, headerAlign, paginationConfig, searchFormConfig, tableWrapStyle = {}, data = [], ...rest } = options;
+	if ((paginationConfig || searchFormConfig) && !realObj(toValue(params))) throw new Error("params must be an object when paginationConfig or searchFormConfig is provided");
+	return [defineComponent((props, { slots }) => {
+		const pageInfo = reactive({
+			pageSize: 10,
+			currentPage: 1
+		});
+		const [SearchForm, { reset, getData }] = searchFormConfig ? useForm(searchFormConfig) : [null, {
+			reset: () => {},
+			getData: () => ({})
+		}];
+		const requestParams = computed(() => {
+			if (paginationConfig) return {
+				...toValue(params) || {},
+				...searchFormConfig ? (getData === null || getData === void 0 ? void 0 : getData()) || {} : {},
+				currentPage: pageInfo.currentPage,
+				pageSize: pageInfo.pageSize
+			};
+			if (searchFormConfig) return {
+				...toValue(params) || {},
+				...(getData === null || getData === void 0 ? void 0 : getData()) || {}
+			};
+			return toValue(params);
+		});
+		const { data: asyncRequestData, loading, execute } = useRequest(service, {
+			manual: false,
+			defaultParams: requestParams.value,
+			formatData
+		});
+		const renderTableItemNodes = (column) => {
+			var _column$children;
+			if (isFunc(column.render)) return { default: ({ row }) => column.render(row) };
+			const tableItemNodes = [];
+			if (column === null || column === void 0 || (_column$children = column.children) === null || _column$children === void 0 ? void 0 : _column$children.length) tableItemNodes.push(...renderTableItems(column.children));
+			return tableItemNodes.length ? () => tableItemNodes : void 0;
+		};
+		const renderTableItem = (column) => {
+			const { align: columnAlign, headerAlign: columnHeaderAlign } = column;
+			const tableItemAlign = columnAlign || align || "left";
+			const tableItemHeaderAlign = columnHeaderAlign || headerAlign || "left";
+			return h(ElTableColumn, {
+				...column,
+				align: tableItemAlign,
+				headerAlign: tableItemHeaderAlign
+			}, renderTableItemNodes(column));
+		};
+		const renderTableItems = (columns) => {
+			return columns.filter(Boolean).map((column) => {
+				return renderTableItem(column);
+			});
+		};
+		function executeRequest() {
+			if (service) execute(requestParams.value);
+		}
+		onMounted(() => {
+			if (service) execute();
+		});
+		const handleReset = () => {
+			reset === null || reset === void 0 || reset();
+			executeRequest();
+		};
+		const handleSearch = () => {
+			executeRequest();
+		};
+		const defaultPaginationLayout = "total, sizes, prev, pager, next, jumper";
+		const defaultPaginationWrapStyle = {
+			display: "flex",
+			justifyContent: "flex-end",
+			alignItems: "center",
+			margin: "20px"
+		};
+		watch(() => toValue(params), () => {
+			executeRequest();
+		}, { deep: true });
+		watch(() => [pageInfo.currentPage, pageInfo.pageSize], () => {
+			executeRequest();
+		});
+		const tableData = computed(() => {
+			if (paginationConfig) {
+				var _asyncRequestData$val;
+				return ((_asyncRequestData$val = asyncRequestData.value) === null || _asyncRequestData$val === void 0 ? void 0 : _asyncRequestData$val.data) || [];
+			}
+			return asyncRequestData.value || data || [];
+		});
+		const tableTotal = computed(() => {
+			var _asyncRequestData$val2;
+			return ((_asyncRequestData$val2 = asyncRequestData.value) === null || _asyncRequestData$val2 === void 0 ? void 0 : _asyncRequestData$val2.total) || 0;
+		});
+		const renderTable = () => {
+			return withDirectives(h(ElTable, {
+				...rest,
+				...props,
+				data: tableData.value
+			}, {
+				default: () => {
+					const tableNodes = [];
+					if (columns.length) tableNodes.push(...renderTableItems(columns));
+					if (slots.actions) tableNodes.push(slots.actions());
+					return tableNodes;
+				},
+				append: slots === null || slots === void 0 ? void 0 : slots.append,
+				empty: slots === null || slots === void 0 ? void 0 : slots.empty
+			}), [[vLoading, loading.value]]);
+		};
+		const renderPagination = () => {
+			return h("div", { style: paginationConfig === true ? defaultPaginationWrapStyle : (paginationConfig === null || paginationConfig === void 0 ? void 0 : paginationConfig.wrapStyle) || defaultPaginationWrapStyle }, [h(ElPagination, {
+				"currentPage": pageInfo.currentPage,
+				"pageSize": pageInfo.pageSize,
+				"total": tableTotal.value,
+				...paginationConfig === true ? {} : paginationConfig,
+				"layout": paginationConfig === true ? defaultPaginationLayout : (paginationConfig === null || paginationConfig === void 0 ? void 0 : paginationConfig.layout) || defaultPaginationLayout,
+				"onUpdate:currentPage": (val) => {
+					pageInfo.currentPage = val;
+				},
+				"onUpdate:pageSize": (val) => {
+					pageInfo.pageSize = val;
+				}
+			})]);
+		};
+		function renderSearchForm() {
+			return h(SearchForm, {}, { footer: () => {
+				return h(ElFormItem, {}, () => [h(ElButton, {
+					type: "default",
+					size: (searchFormConfig === null || searchFormConfig === void 0 ? void 0 : searchFormConfig.size) || "small",
+					onClick: handleReset
+				}, () => "Reset"), h(ElButton, {
+					type: "primary",
+					size: (searchFormConfig === null || searchFormConfig === void 0 ? void 0 : searchFormConfig.size) || "small",
+					onClick: handleSearch
+				}, () => "Search")]);
+			} });
+		}
+		function renderTableWrapChildNodes() {
+			const childNodes = [];
+			if (searchFormConfig) childNodes.push(renderSearchForm());
+			if (slots === null || slots === void 0 ? void 0 : slots.header) childNodes.push(slots.header());
+			childNodes.push(renderTable());
+			if (paginationConfig) childNodes.push(renderPagination());
+			return childNodes;
+		}
+		return () => {
+			return h("div", { style: { ...tableWrapStyle || {} } }, renderTableWrapChildNodes());
+		};
+	})];
+}
+//#endregion
+export { setDeepProperty, useAsyncConfirm, useForm, useMessage, useTable };

package/package.json

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