element-pro-components/types/Crud/type.d.ts

a component library for Vue 3 base on element-plus

import { crudProps, crudEmits } from './props';
import type { ButtonProps } from 'element-plus';
import type { IDefineProps, IDefineEmits, UnknownObject, ExternalParam, FormColumnChildren } from '../types/index';
import type { FormColumn, GroupFormColumn, IFormMenuColumns, IFormExpose, IFormSubmit, InvalidFields } from '../Form/index';
import type { ISearchProps } from '../Search/type';
import type { TableColumn, ITableMenuColumns, ITableExpose } from '../Table/index';
import type { DescriptionsColumn } from '../Descriptions/type';
interface CommonCrudColumn<T> extends Omit<TableColumn<T>, 'children'>, Omit<DescriptionsColumn<T>, 'span'> {
    /** sub-form and multi-level header */
    children?: ICrudColumns<T & FormColumnChildren<T>>;
    /** whether to display in the add form */
    add?: boolean;
    /** whether to display in the edit form */
    edit?: boolean;
    /** whether to display in the add and edit form */
    form?: boolean;
    /** whether to display in the detail descriptions */
    detail?: boolean;
    /** whether to display in the search form */
    search?: boolean;
    /** rename the descriptions column prop `span` to `detailSpan` */
    detailSpan?: DescriptionsColumn<T>['span'];
}
export type CrudColumn<T = ExternalParam> = Omit<FormColumn<T>, 'children'> & CommonCrudColumn<T>;
export type CrudGroupFormColumn<T = ExternalParam> = Omit<GroupFormColumn<T>, 'children'> & CommonCrudColumn<T>;
/** Crud Columns Options */
export type ICrudColumns<T = ExternalParam> = Array<(CrudColumn<T> | CrudGroupFormColumn<T>) & UnknownObject>;
export interface CrudMenu<T = ExternalParam> {
    /** show add button */
    add?: boolean;
    /** text of add button */
    addText?: string;
    /** props of add button */
    addProps?: Partial<ButtonProps>;
    /** show edit button */
    edit?: boolean | ((row: T) => boolean);
    /** text of edit button */
    editText?: string;
    /** props of edit button */
    editProps?: Partial<ButtonProps>;
    /** show detail button */
    detail?: boolean | ((row: T) => boolean);
    /** text of detail button */
    detailText?: string;
    /** props of detail button */
    detailProps?: Partial<ButtonProps>;
    /** show del button */
    del?: boolean | ((row: T) => boolean);
    /** text of del button */
    delText?: string;
    /** props of del button */
    delProps?: Partial<ButtonProps>;
    /** show search button */
    search?: boolean;
    /** text of search button */
    searchText?: string;
    /** props of search button */
    searchProps?: Partial<ButtonProps>;
    /** show search reset button */
    searchReset?: boolean;
    /** text of search reset button */
    searchResetText?: string;
    /** props of search reset button */
    searchResetProps?: Partial<ButtonProps>;
    /** text of prev button in search form */
    searchPrevText?: string;
    /** props of prev button in search form */
    searchPrevProps?: Partial<ButtonProps>;
    /** text of next button in search form */
    searchNextText?: string;
    /** props of next button in search form */
    searchNextProps?: Partial<ButtonProps>;
}
export type ICrudMenuColumns<T = ExternalParam> = CrudMenu<T> & ITableMenuColumns & IFormMenuColumns;
export type ICrudDialogType = 'add' | 'edit' | 'detail';
export type ICrudBeforeOpen<T = ExternalParam> = (done: () => void, type: ICrudDialogType, row?: T) => void;
export type ICrudBeforeClose = (done: () => void) => void;
export type ICrudSearch = IFormSubmit;
export type ICrudSearchProps = Partial<Omit<ISearchProps, 'modelValue' | 'columns' | 'menu' | 'size'>>;
export type ICrudSubmit = (close: () => void, done: () => void, type: ICrudDialogType, isValid: boolean, invalidFields?: InvalidFields) => void;
export type ICrudProps = IDefineProps<typeof crudProps>;
export type ICrudEmits = IDefineEmits<typeof crudEmits>;
export interface ICrudExpose<T = UnknownObject> extends IFormExpose, ITableExpose<T> {
    searchRef: IFormExpose;
    formRef: IFormExpose;
    /** open the dialog */
    openDialog: (type: ICrudDialogType, row?: UnknownObject) => void;
    /** close the dialog */
    closeDialog: () => void;
}
/**
 * Type helper to make it easier to define columns
 * @param columns the columns of Crud
 */
export declare function defineCrudColumns<T = ExternalParam>(columns: ICrudColumns<T>): ICrudColumns<T>;
/**
 * Type helper to make it easier to define menu columns
 * @param columns the columns of Menu
 */
export declare function defineCrudMenuColumns<T = ExternalParam>(columns: ICrudMenuColumns<T>): ICrudMenuColumns<T>;
/**
 * Type helper to make it easier to define function (before the dialog is opened)
 * @param fun function
 */
export declare function defineCrudBeforeOpen<T = ExternalParam>(fun: ICrudBeforeOpen<T>): ICrudBeforeOpen<T>;
/**
 * Type helper to make it easier to define function (before the dialog is closed)
 * @param fun function
 */
export declare function defineCrudBeforeClose(fun: ICrudBeforeClose): ICrudBeforeClose;
/**
 * Type helper to make it easier to define search function
 * @param fun search function
 */
export declare function defineCrudSearch(fun: ICrudSearch): ICrudSearch;
/**
 * Type helper to make it easier to define submit function
 * @param fun submit function
 */
export declare function defineCrudSubmit(fun: ICrudSubmit): ICrudSubmit;
export {};