@yetuzi/vue3-query-components 1.1.37 → 1.2.0

package/dist/index.css

@@ -1 +1 @@
-.common-query-table[data-v-a726f75e]{--spacing: 15px;width:100%;height:100%;flex:1;display:flex;flex-direction:column;box-sizing:border-box;padding:var(--spacing) 12px;overflow:hidden}[class^=common-query-table-][data-v-a726f75e]{width:100%}[class^=common-query-table-]+[class^=common-query-table-][data-v-a726f75e]{margin-top:var(--spacing)}.common-query-table .common-query-table-table[data-v-a726f75e]{flex:1;overflow:hidden}.el-form[data-v-819162d5]{margin-bottom:-18px!important}.el-form .el-form-item[data-v-819162d5] .el-form-item__content{width:var(--v91075878)}.el-form .el-form-item[data-v-819162d5] .el-select,.el-form .el-form-item[data-v-819162d5] .el-input,.el-form .el-form-item[data-v-819162d5] .el-date-editor{width:100%}.common-table[data-v-4a5a2714]{width:100%;height:100%;display:flex;flex-direction:column}
+.common-query-table[data-v-a726f75e]{--spacing: 15px;width:100%;height:100%;flex:1;display:flex;flex-direction:column;box-sizing:border-box;padding:var(--spacing) 12px;overflow:hidden}[class^=common-query-table-][data-v-a726f75e]{width:100%}[class^=common-query-table-]+[class^=common-query-table-][data-v-a726f75e]{margin-top:var(--spacing)}.common-query-table .common-query-table-table[data-v-a726f75e]{flex:1;overflow:hidden}.el-form[data-v-21a094af]{margin-bottom:-18px!important}.el-form .el-form-item[data-v-21a094af] .el-form-item__content{width:var(--v61f64934)}.el-form .el-form-item[data-v-21a094af] .el-select,.el-form .el-form-item[data-v-21a094af] .el-input,.el-form .el-form-item[data-v-21a094af] .el-date-editor{width:100%}.common-table[data-v-4dc3e15a]{width:100%;height:100%;display:flex;flex-direction:column}

package/dist/index.d.ts

@@ -284,12 +284,6 @@ export declare const CommonCheckbox: DefineComponent<__VLS_PublicProps_6, {}, {}
 "onUpdate:modelValue"?: ((value: CheckboxGroupValueType) => any) | undefined;
 }>, {}, {}, {}, {}, string, ComponentProvideOptions, false, {}, any>;
 
-/**
- * 多选框
- */
-declare interface CommonCheckboxItem<T extends AnyObject> extends CommonFormSupplement<'check-box', CommonCheckboxProps, T> {
-}
-
 export declare interface CommonCheckboxProps extends ExtractPublicPropTypes<CheckboxGroupProps> {
 }
 
@@ -303,12 +297,6 @@ export declare const CommonConfigProvider: __VLS_WithTemplateSlots<typeof __VLS_
 export declare interface CommonConfigProviderProps extends /* @vue-ignore */ DeepPartial<Config> {
 }
 
-/**
- * 自定义组件
- */
-declare interface CommonCustomComponentsItem<T extends AnyObject, C extends Component = Component, P = ComponentProps<C>> extends CommonFormSupplement<C, P, T> {
-}
-
 export declare const CommonDatePicker: DefineComponent<__VLS_PublicProps_4, {}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {
 "update:modelValue": (value: ModelValueType) => any;
 }, string, PublicProps, Readonly<__VLS_PublicProps_4> & Readonly<{
@@ -323,12 +311,6 @@ readonly startPlaceholder: string;
 readonly endPlaceholder: string;
 }, {}, {}, {}, string, ComponentProvideOptions, false, {}, any>;
 
-/**
- * 日期选择器
- */
-declare interface CommonDatePickerItem<T extends AnyObject> extends CommonFormSupplement<'date-picker', CommonDatePickerProps, T> {
-}
-
 /** CommonDatePicker组件属性类型，继承自Element Plus DatePicker组件 */
 export declare interface CommonDatePickerProps extends Partial<DatePickerProps> {
 }
@@ -353,6 +335,18 @@ export declare const CommonForm: <T extends AnyObject>(__VLS_props: NonNullable<
     __ctx?: Awaited<typeof __VLS_setup>;
 };
 
+/**
+ * 多选框
+ */
+export declare interface CommonFormCheckboxItem<T extends AnyObject> extends CommonFormSupplement<'check-box', CommonCheckboxProps, T> {
+}
+
+/**
+ * 自定义组件
+ */
+export declare interface CommonFormCustomComponentsItem<T extends AnyObject, C extends Component = Component, P = ComponentProps<C>> extends CommonFormSupplement<C, P, T> {
+}
+
 /**
  * 表单数据类型，支持通过prop访问
  */
@@ -360,6 +354,12 @@ export declare type CommonFormData<T extends AnyObject> = T & {
     [key: string]: any;
 };
 
+/**
+ * 日期选择器
+ */
+export declare interface CommonFormDatePickerItem<T extends AnyObject> extends CommonFormSupplement<'date-picker', CommonDatePickerProps, T> {
+}
+
 /**
  * CommonForm 组件实例暴露类型
  * 继承 FormInstance 的所有方法，可直接调用 validate()、resetFields() 等
@@ -373,10 +373,24 @@ export declare interface CommonFormExpose<T extends AnyObject = AnyObject> exten
 /**
  * 输入框组件
  */
-declare interface CommonFormInputItem<T extends AnyObject> extends CommonFormSupplement<'input', CommonInputProps, T> {
+export declare interface CommonFormInputItem<T extends AnyObject> extends CommonFormSupplement<'input', CommonInputProps, T> {
 }
 
-export declare type CommonFormPropForm<T extends AnyObject> = Array<CommonFormSelectItem<T> | CommonFormInputItem<T> | CommonDatePickerItem<T> | CommonRadioItem<T> | CommonCustomComponentsItem<T> | CommonCheckboxItem<T> | CommonSwitchItem<T>>;
+/**
+ * 表单项类型数组
+ * 用于 CommonForm 的 form 属性，也可用于类型标注
+ *
+ * @example
+ * ```ts
+ * import type { CommonFormPropForm } from '@yetuzi/vue3-query-components'
+ *
+ * const form: CommonFormPropForm<MyDataType> = [
+ *   { is: 'input', prop: 'name', label: '用户名' },
+ *   { is: 'select', prop: 'status', label: '状态' }
+ * ]
+ * ```
+ */
+export declare type CommonFormPropForm<T extends AnyObject> = Array<CommonFormSelectItem<T> | CommonFormInputItem<T> | CommonFormDatePickerItem<T> | CommonFormRadioItem<T> | CommonFormCustomComponentsItem<T> | CommonFormCheckboxItem<T> | CommonFormSwitchItem<T>>;
 
 /**
  * form 组件props
@@ -385,14 +399,20 @@ export declare interface CommonFormProps<T extends AnyObject> extends ExtractPro
     form?: CommonFormPropForm<T>;
 }
 
+/**
+ * 单选框
+ */
+export declare interface CommonFormRadioItem<T extends AnyObject> extends CommonFormSupplement<'radio', CommonRadioProps, T> {
+}
+
 /**
  * 选择器组件
  */
-declare interface CommonFormSelectItem<T extends AnyObject> extends CommonFormSupplement<'select', CommonSelectProps, T> {
+export declare interface CommonFormSelectItem<T extends AnyObject> extends CommonFormSupplement<'select', CommonSelectProps, T> {
 }
 
 declare interface CommonFormSupplement<T, P, D extends AnyObject, V = any> {
-    is: T;
+    is: T | (string & {});
     label?: string;
     prop: keyof D | (string & {});
     props?: Partial<P>;
@@ -400,6 +420,12 @@ declare interface CommonFormSupplement<T, P, D extends AnyObject, V = any> {
     formItem?: Partial<Omit<FormItemProps, 'prop' | 'label'>>;
 }
 
+/**
+ * 开关
+ */
+export declare interface CommonFormSwitchItem<T extends AnyObject> extends CommonFormSupplement<'switch', CommonSwitchProps, T> {
+}
+
 export declare const CommonInput: __VLS_WithTemplateSlots_5<typeof __VLS_component_5, __VLS_TemplateResult_5["slots"]>;
 
 /** CommonInput组件属性类型，忽略复杂类型检查 */
@@ -455,12 +481,6 @@ export declare const CommonRadio: DefineComponent<__VLS_PublicProps_5, {}, {}, {
 "onUpdate:modelValue"?: ((value: EpPropMergeType<readonly [StringConstructor, NumberConstructor, BooleanConstructor], unknown, unknown> | undefined) => any) | undefined;
 }>, {}, {}, {}, {}, string, ComponentProvideOptions, false, {}, any>;
 
-/**
- * 单选框
- */
-declare interface CommonRadioItem<T extends AnyObject> extends CommonFormSupplement<'radio', CommonRadioProps, T> {
-}
-
 /** CommonRadio组件属性类型，提取自Element Plus RadioGroup组件的公共属性 */
 export declare interface CommonRadioProps extends ExtractPublicPropTypes<RadioGroupProps> {
 }
@@ -485,12 +505,6 @@ export declare const CommonSwitch: DefineComponent<__VLS_PublicProps_7, {}, {},
 "onUpdate:modelValue"?: ((value: EpPropMergeType<readonly [BooleanConstructor, StringConstructor, NumberConstructor], unknown, unknown>) => any) | undefined;
 }>, {}, {}, {}, {}, string, ComponentProvideOptions, false, {}, any>;
 
-/**
- * 开关
- */
-declare interface CommonSwitchItem<T extends AnyObject> extends CommonFormSupplement<'switch', CommonSwitchProps, T> {
-}
-
 /**
  * CommonSwitch组件属性类型
  * 继承自Element Plus Switch组件的公共属性，并扩展自定义颜色配置
@@ -527,7 +541,21 @@ export declare const CommonTable: <T extends AnyObject>(__VLS_props: NonNullable
     __ctx?: Awaited<typeof __VLS_setup>;
 };
 
-/** Columns 为 Array 时的ts类型 */
+/**
+ * 表格列类型数组
+ * 用于 CommonTable 的 columns 属性，也可用于类型标注
+ *
+ * @example
+ * ```ts
+ * import type { CommonTableArrayColumns } from '@yetuzi/vue3-query-components'
+ *
+ * const columns: CommonTableArrayColumns<MyDataType> = [
+ *   { prop: 'id', label: 'ID', type: 'index' },
+ *   { prop: 'name', label: '用户名' },
+ *   { prop: 'createTime', label: '创建时间', type: 'dateTime' }
+ * ]
+ * ```
+ */
 export declare type CommonTableArrayColumns<T extends AnyObject> = Array<CommonTableColumnRoot<T>>;
 
 export declare type CommonTableColumn<T extends AnyObject> = CommonTableArrayColumns<T> | CommonTableObjectColumns<T>;
@@ -655,6 +683,25 @@ export declare function getCommonProviderConfig(): {
  */
 export declare function getFirstValidValue<T>(...args: T[]): T | undefined;
 
+/**
+ * 表单项类型守卫辅助函数
+ * 用于检查表单项的 is 属性是否为指定类型
+ *
+ * @param item - 表单项对象
+ * @param type - 要检查的类型字符串
+ * @returns 是否为指定类型
+ *
+ * @example
+ * ```ts
+ * if (isFormItemType(item, 'select')) {
+ *   // item 在这里被推断为 CommonFormSelectItem
+ * }
+ * ```
+ */
+export declare function isFormItemType<T extends AnyObject>(item: CommonFormPropForm<T>[number], type: string): item is CommonFormPropForm<T>[number] & {
+    is: string;
+};
+
 /**
  * 列表请求 参数要求,包含分页
  */
@@ -699,9 +746,17 @@ export declare type RequiredSomeFields<T extends object, K extends keyof T> = Om
 /** 增强 TableColumn 的类型 */
 declare interface TableColumnSupplement<T extends AnyObject> extends Partial<Omit<TableColumnCtx<T>, 'prop' | 'type'>> {
     prop: keyof T | (string & {});
-    type?: 'index' | 'selection' | 'expand' | 'date' | 'dateTime';
+    type?: TableColumnType | (string & {});
 }
 
+/**
+ * 表格列类型
+ * 从 CommonTableColumnRoot 中自动提取 type 字段的类型
+ */
+export declare type TableColumnType = Extract<CommonTableColumnRoot<AnyObject>, {
+    type: any;
+}>['type'];
+
 /**
  * 日期时间
  */