@mythpe/quasar-ui-qui 0.5.49 → 0.5.50

package/dist/components/datatable/MDatatable/MDatatable.d.ts

@@ -0,0 +1,260 @@
+import { ComputedRef, MaybeRef, MaybeRefOrGetter, Ref, UnwrapRef, VNode } from 'vue';
+import { GenericFormValues } from '../../form';
+import { NamedColor, QTableProps } from 'quasar';
+import { ApiMetaResource, ApiServicesSchema, ClassProp, StyleProp } from '../../../types';
+import { RouteLocationRaw } from 'vue-router';
+import { MDtBtnProps } from '../MDtBtn';
+export type MDtItem<T extends object = Record<string, any>> = T & {
+    id: any;
+    value: any;
+} & Record<string, any>;
+export type MDtItemIndex = number;
+export type MDtExportOptions = 'pdf' | 'excel';
+export interface MDatatablePagination {
+    /**
+     * Column name (from column definition)
+     */
+    sortBy?: string;
+    /**
+     * Is sorting in descending order?
+     */
+    descending?: boolean;
+    /**
+     * Page number (1-based)
+     */
+    page: number;
+    /**
+     * How many rows per page? 0 means Infinite
+     */
+    rowsPerPage?: number;
+    /**
+     * For server-side fetching only. How many total database rows are there to be added to the table.
+     */
+    rowsNumber?: number;
+}
+export type MDatatableFilterForm = Partial<GenericFormValues>;
+export interface FetchRowsArgs {
+    filter?: string | null;
+    pagination?: MDatatablePagination;
+}
+export interface ApiServiceParams {
+    filter?: Record<string, any>;
+    search?: string | null;
+    searchColumns?: string[] | string;
+    headerItems?: any[] | string[] | string;
+    ids?: number[];
+    indexType: 'index' | 'pdf' | 'excel';
+    fdt: 'i' | 'e' | 'u' | 'c' | 's' | 'd';
+    requestWith?: string;
+    itemsPerPage: number;
+    page: number;
+    sortBy?: string;
+    sortDesc?: number;
+    toUrl?: MDtExportOptions | boolean;
+    [key: string]: any;
+}
+export type MDtMythApiServicesSchema = ApiServicesSchema<MDtItem>;
+export type MDatatableMetaServer = ApiMetaResource;
+export type MDtControlOptions = {
+    name?: 'control' | string;
+    justify?: 'start' | 'center' | 'end' | 'around' | 'between' | undefined | null;
+    style?: StyleProp;
+    align?: 'left' | 'right' | 'center' | undefined | null;
+};
+export type MDatatableOptions = {
+    hasAction: Ref<boolean>;
+    loading: Ref<boolean>;
+    search: Ref<string | null | undefined>;
+    pagination: Ref<MDatatablePagination>;
+    meta: Ref<MDatatableMetaServer>;
+    filter: Ref<MDatatableFilterForm>;
+    tempFilter: Ref<MDatatableFilterForm>;
+    selected: Ref<MDtItem[]>;
+    fullscreen: Ref<boolean>;
+    getHeaders: ComputedRef<string[] | Partial<QTableProps['columns']> | any[]>;
+    controlProps: ComputedRef<Required<MDtControlOptions>>;
+    visibleHeaders: Ref<any[]>;
+};
+export type MDatatableDialogsOptions = {
+    filter: Ref<boolean>;
+    show: Ref<boolean>;
+    form: Ref<boolean>;
+    isUpdate: Ref<boolean>;
+    item: MaybeRef<any> | undefined;
+    index: Ref<MDtItemIndex | undefined>;
+    errors: Record<string | number | symbol, string[]> | any;
+};
+type E = MDatatableDialogsOptions['item'];
+export type GenericMDtBtn = Record<string, any> & {
+    name: string;
+    label?: string | ((item: any, index: number) => string);
+    contextLabel?: string | null;
+    tooltip?: string | ((item: any, index: number) => string);
+    click?: <V extends E>(item: UnwrapRef<V> | Ref<V> | V, index: UnwrapRef<MDatatableDialogsOptions['index']>) => void;
+    multiClick?: <V extends E = E>(items: V[]) => void;
+    showIf?: boolean | ((item: UnwrapRef<MDatatableDialogsOptions['item']>, index: UnwrapRef<MDatatableDialogsOptions['index']>) => boolean);
+    order?: number;
+    attr?: Partial<MDtBtnProps> & Partial<{
+        icon?: string;
+        textColor?: NamedColor | undefined;
+        color?: NamedColor | undefined;
+    }>;
+};
+export interface MDatatableProps<I extends GenericFormValues = GenericFormValues> extends Omit<QTableProps, 'rows' | 'rowsPerPageOptions' | 'visibleColumns'> {
+    rows?: any[];
+    control?: any;
+    defaultItem?: any;
+    contextItems?: any;
+    contextItemsLength?: number;
+    hideAutoMessage?: boolean;
+    headers: string[] | Partial<QTableProps['columns']> | any[];
+    serviceName?: any;
+    requestParams?: any;
+    pdf?: boolean;
+    excel?: boolean;
+    exportUrl?: any | boolean;
+    importBtn?: boolean;
+    noExampleBtn?: boolean;
+    hideSearch?: boolean;
+    hideTitle?: boolean;
+    searchDebounce?: string | number;
+    withIndex?: string | string[];
+    withStore?: string | string[];
+    withShow?: string | string[];
+    withUpdate?: string | string[];
+    hideAddBtn?: boolean;
+    storeBtnFn?: (item: MDtItem<I>) => boolean;
+    hideUpdateBtn?: boolean;
+    updateBtnFn?: (item: MDtItem<I>) => boolean;
+    cloneBtn?: boolean;
+    cloneBtnFn?: (item: MDtItem<I>) => boolean;
+    hideShowBtn?: boolean;
+    showBtnFn?: (item: MDtItem<I>) => boolean;
+    hideDestroyBtn?: boolean;
+    destroyBtnFn?: (item: MDtItem<I>) => boolean;
+    storeRoute?: string | RouteLocationRaw;
+    storeQueryParams?: boolean;
+    noStoreClose?: boolean;
+    updateRoute?: string | RouteLocationRaw;
+    updateQueryParams?: boolean;
+    noUpdateClose?: boolean;
+    noAutoClose?: boolean;
+    showRoute?: string | RouteLocationRaw;
+    showQueryParams?: boolean;
+    noMouse?: boolean;
+    noRefreshBtn?: boolean;
+    endReach?: boolean;
+    showSelection?: boolean;
+    hideSelection?: boolean;
+    multiSelection?: boolean;
+    multiDestroy?: boolean;
+    rowsPerPageOptions?: (string | number)[];
+    ignoreKeys?: string[] | ((form: Record<string, any>) => string[]) | any[];
+    manageColumns?: boolean;
+    manageColumnsInline?: boolean;
+    visibleColumns?: (string | null | undefined)[] | any[];
+    /**
+     * Show Add btn top of the table.
+     */
+    addTopBtn?: boolean;
+    /**
+     * Show Add btn inside more list
+     */
+    addListBtn?: boolean;
+    /**
+     * Show Fab Add btn
+     */
+    addFabBtn?: boolean;
+    /**
+     * make datatable fullscreen mode
+     */
+    fullscreenBtn?: boolean;
+    /**
+     * Auto actions body headers 'control'
+     */
+    noBodyControl?: boolean;
+    /**
+     * Auto actions card 'control'
+     */
+    showCardControlHeader?: boolean;
+    /**
+     * Set datatable to fixed view
+     */
+    fixed?: boolean;
+    /**
+     * Names of image columns in the table.
+     */
+    imageColumns?: string[] | any[];
+    /**
+     * How to display the image button in the table.
+     */
+    imageMode?: 'icon' | 'image';
+    /**
+     * Image size in display
+     */
+    imageSize?: string;
+    /**
+     * Remove the default back btn.
+     * use router back
+     */
+    noBackBtn?: boolean;
+    /**
+     * default back icon.
+     */
+    backIcon?: string;
+    /**
+     * Names of url/link columns in the table.
+     */
+    urlColumns?: MaybeRefOrGetter<string[]>;
+    /**
+     * Names of color pattern columns in the table.
+     */
+    colorColumns?: MaybeRefOrGetter<string[]>;
+    /**
+     * Names of SAR columns in the table.
+     */
+    sarColumns?: MaybeRefOrGetter<string[]>;
+    /**
+     * Names of a text want to show copy btn
+     */
+    copyColumns?: MaybeRefOrGetter<string[]>;
+    /**
+     * Names of a text want to show be truncate text
+     */
+    descColumns?: MaybeRefOrGetter<string[]>;
+    /**
+     * Help Tooltip
+     */
+    help?: string;
+    /**
+     * Subtitle of table
+     */
+    subtitle?: string;
+    /**
+     * Subtitle of class
+     */
+    subtitleClass?: ClassProp;
+    /**
+     * Show, hide, wrap the button in the table.
+     */
+    noWrapBtn?: boolean;
+    /**
+     * Align all table columns to the left, center, or right.
+     */
+    align?: 'left' | 'right' | 'center';
+    /**
+     * too small a screen size in px.
+     */
+    tooSmall?: number;
+    /**
+     * transformer for form data
+     */
+    transformer?: (formData: any) => any;
+}
+export interface MDatatableSlots {
+    /**
+     * Default slot in the Devland unslotted content of the component
+     */
+    default: () => VNode[];
+}
+export {};