@rotki/ui-library 0.15.0 → 1.0.0-beta.1

package/dist/components/tables/RuiDataTable.vue.d.ts

@@ -0,0 +1,512 @@
+import { type TablePaginationData } from '../../components/tables/RuiTablePagination.vue';
+import { type GroupData, type GroupKeys, type TableColumn, type TableRowKeyData, type TableSortData } from '../../components/tables/RuiTableHead.vue';
+export interface TableOptions<T> {
+    pagination?: TablePaginationData;
+    sort?: TableSortData<T>;
+}
+export interface GroupHeader<T> {
+    __header__: true;
+    identifier: string;
+    group: Partial<T>;
+}
+export type GroupedTableRow<T> = T | GroupHeader<T>;
+export interface Props<T, K extends keyof T> {
+    /**
+     * list of items for each row
+     */
+    rows: T[];
+    /**
+     * the attribute used to identify each row uniquely for selection, usually `id`
+     */
+    rowAttr: K;
+    /**
+     * model for selected rows, add a v-model to support row selection
+     */
+    modelValue?: T[K][];
+    /**
+     * model for internal searching
+     */
+    search?: string;
+    /**
+     * model for items per page
+     * will be used if the `pagination` model isn't specified
+     */
+    itemsPerPage?: number;
+    /**
+     * model for paginating data
+     * @example v-model:pagination="{ total: 10, limit: 5, page: 1 }"
+     */
+    pagination?: TablePaginationData;
+    /**
+     * modifiers for specifying externally paginated tables
+     * use this when api controls pagination
+     * @example v-model:pagination.external="{ total: 10, limit: 5, page: 1 }"
+     */
+    paginationModifiers?: {
+        external: boolean;
+    };
+    /**
+     * model for sort column/columns data
+     * single column sort
+     * @example v-model:sort="{ column: 'name', direction: 'asc' }"
+     * multi columns sort
+     * @example v-model:sort="[{ column: 'name', direction: 'asc' }]"
+     */
+    sort?: TableSortData<T>;
+    /**
+     * modifiers for specifying externally sorted tables
+     * use this when api controls sorting
+     * single column sort
+     * @example v-model:sort.external="{ column: 'name', direction: 'asc' }"
+     * multi columns sort
+     * @example v-model:sort.external="[{ column: 'name', direction: 'asc' }]"
+     */
+    sortModifiers?: {
+        external: boolean;
+    };
+    /**
+     * list of column definitions
+     */
+    cols?: TableColumn<T>[];
+    /**
+     * attribute to use from column definitions to display column titles
+     */
+    columnAttr?: keyof TableColumn<T>;
+    /**
+     * flag to show a more or less spacious table
+     */
+    dense?: boolean;
+    /**
+     * flag to outline the flag with a border
+     */
+    outlined?: boolean;
+    /**
+     * should add zebra-striping to the table row
+     */
+    striped?: boolean;
+    /**
+     * flag to show loading state of the table
+     * triggers indefinite progress at the bottom of the table header
+     */
+    loading?: boolean;
+    disablePerPage?: boolean;
+    /**
+     * data to display for empty state
+     * text and icon
+     * @example :empty="{ icon: 'transactions-line', label: 'No transactions found' }"
+     */
+    empty?: {
+        label?: string;
+        description?: string;
+    };
+    /**
+     * should hide the footer
+     */
+    hideDefaultFooter?: boolean;
+    rounded?: 'sm' | 'md' | 'lg';
+    /**
+     * model for expanded rows
+     */
+    expanded?: T[];
+    /**
+     * make expansion work like accordion
+     */
+    singleExpand?: boolean;
+    /**
+     * make table head stick to top on scroll
+     */
+    stickyHeader?: boolean;
+    stickyOffset?: number;
+    /**
+     * Affects how the items per page work across the app.
+     * When true, changing the items per page setting in one table will affect other tables.
+     */
+    globalItemsPerPage?: boolean;
+    /**
+     * model for grouping column/columns data
+     * single column grouping
+     * @example v-model:group="'name'"
+     * multi columns grouping
+     * @example v-model:group="['name', 'country']"
+     */
+    group?: TableRowKeyData<T>;
+    groupExpandButtonPosition?: 'start' | 'end';
+    collapsed?: T[];
+    disabledRows?: T[];
+    multiPageSelect?: boolean;
+    scroller?: HTMLElement | null;
+    itemClass?: ((item: T) => string) | string;
+}
+declare const _default: <T extends object, IdType extends keyof T = keyof T>(__VLS_props: {
+    "onUpdate:model-value"?: ((value?: T[IdType][] | undefined) => any) | undefined;
+    "onUpdate:expanded"?: ((value: T[]) => any) | undefined;
+    "onUpdate:pagination"?: ((value: TablePaginationData) => any) | undefined;
+    "onUpdate:sort"?: ((value?: TableSortData<T>) => any) | undefined;
+    "onUpdate:options"?: ((value: TableOptions<T>) => any) | undefined;
+    "onUpdate:group"?: ((value?: GroupKeys<T>) => any) | undefined;
+    "onUpdate:collapsed"?: ((value?: T[] | undefined) => any) | undefined;
+    "onCopy:group"?: ((value: GroupData<T>) => any) | undefined;
+    rows: T[];
+    rowAttr: IdType;
+    modelValue?: T[IdType][] | undefined;
+    search?: string | undefined;
+    itemsPerPage?: number | undefined;
+    pagination?: TablePaginationData | undefined;
+    paginationModifiers?: {
+        external: boolean;
+    } | undefined;
+    sort?: TableSortData<T>;
+    sortModifiers?: {
+        external: boolean;
+    } | undefined;
+    cols?: TableColumn<T>[] | undefined;
+    columnAttr?: string | number | undefined;
+    dense?: boolean | undefined;
+    outlined?: boolean | undefined;
+    striped?: boolean | undefined;
+    loading?: boolean | undefined;
+    disablePerPage?: boolean | undefined;
+    empty?: {
+        label?: string | undefined;
+        description?: string | undefined;
+    } | undefined;
+    hideDefaultFooter?: boolean | undefined;
+    rounded?: "sm" | "md" | "lg" | undefined;
+    expanded?: T[] | undefined;
+    singleExpand?: boolean | undefined;
+    stickyHeader?: boolean | undefined;
+    stickyOffset?: number | undefined;
+    globalItemsPerPage?: boolean | undefined;
+    group?: TableRowKeyData<T>;
+    groupExpandButtonPosition?: "end" | "start" | undefined;
+    collapsed?: T[] | undefined;
+    disabledRows?: T[] | undefined;
+    multiPageSelect?: boolean | undefined;
+    scroller?: HTMLElement | null | undefined;
+    itemClass?: string | ((item: T) => string) | undefined;
+} & import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, __VLS_ctx?: {
+    attrs: any;
+    emit: {
+        (e: 'update:model-value', value?: T[IdType][]): void;
+        (e: 'update:expanded', value: T[]): void;
+        (e: 'update:pagination', value: TablePaginationData): void;
+        (e: 'update:sort', value?: TableSortData<T>): void;
+        (e: 'update:options', value: TableOptions<T>): void;
+        (e: 'update:group', value?: GroupKeys<T>): void;
+        (e: 'update:collapsed', value?: T[]): void;
+        (e: 'copy:group', value: GroupData<T>): void;
+    };
+    slots: Readonly<Partial<Record<`header.${string}`, (props: {
+        column: TableColumn<T>;
+    }) => any> & Record<`item.${string}`, (props: {
+        column: TableColumn<T>;
+        row: T;
+        index: number;
+    }) => any> & {
+        'body.prepend': (props: {
+            colspan: number;
+        }) => any;
+        'body.append': (props: {
+            colspan: number;
+        }) => any;
+        'group.header': (props: {
+            colspan: number;
+            header: GroupHeader<T>;
+            isOpen: boolean;
+            toggle: () => void;
+        }) => any;
+        'group.header.content': (props: {
+            header: GroupHeader<T>;
+            groupKey: string;
+        }) => any;
+        'expanded-item': (props: {
+            row: T;
+            index: number;
+        }) => any;
+        'no-data': () => any;
+        'empty-description': () => any;
+        tfoot: () => any;
+    }>> & Partial<Record<`header.${string}`, (props: {
+        column: TableColumn<T>;
+    }) => any> & Record<`item.${string}`, (props: {
+        column: TableColumn<T>;
+        row: T;
+        index: number;
+    }) => any> & {
+        'body.prepend': (props: {
+            colspan: number;
+        }) => any;
+        'body.append': (props: {
+            colspan: number;
+        }) => any;
+        'group.header': (props: {
+            colspan: number;
+            header: GroupHeader<T>;
+            isOpen: boolean;
+            toggle: () => void;
+        }) => any;
+        'group.header.content': (props: {
+            header: GroupHeader<T>;
+            groupKey: string;
+        }) => any;
+        'expanded-item': (props: {
+            row: T;
+            index: number;
+        }) => any;
+        'no-data': () => any;
+        'empty-description': () => any;
+        tfoot: () => any;
+    }>;
+} | undefined, __VLS_expose?: ((exposed: import('vue').ShallowUnwrapRef<{}>) => void) | undefined, __VLS_setup?: Promise<{
+    props: {
+        "onUpdate:model-value"?: ((value?: T[IdType][] | undefined) => any) | undefined;
+        "onUpdate:expanded"?: ((value: T[]) => any) | undefined;
+        "onUpdate:pagination"?: ((value: TablePaginationData) => any) | undefined;
+        "onUpdate:sort"?: ((value?: TableSortData<T>) => any) | undefined;
+        "onUpdate:options"?: ((value: TableOptions<T>) => any) | undefined;
+        "onUpdate:group"?: ((value?: GroupKeys<T>) => any) | undefined;
+        "onUpdate:collapsed"?: ((value?: T[] | undefined) => any) | undefined;
+        "onCopy:group"?: ((value: GroupData<T>) => any) | undefined;
+        rows: T[];
+        rowAttr: IdType;
+        modelValue?: T[IdType][] | undefined;
+        search?: string | undefined;
+        itemsPerPage?: number | undefined;
+        pagination?: TablePaginationData | undefined;
+        paginationModifiers?: {
+            external: boolean;
+        } | undefined;
+        sort?: TableSortData<T>;
+        sortModifiers?: {
+            external: boolean;
+        } | undefined;
+        cols?: TableColumn<T>[] | undefined;
+        columnAttr?: string | number | undefined;
+        dense?: boolean | undefined;
+        outlined?: boolean | undefined;
+        striped?: boolean | undefined;
+        loading?: boolean | undefined;
+        disablePerPage?: boolean | undefined;
+        empty?: {
+            label?: string | undefined;
+            description?: string | undefined;
+        } | undefined;
+        hideDefaultFooter?: boolean | undefined;
+        rounded?: "sm" | "md" | "lg" | undefined;
+        expanded?: T[] | undefined;
+        singleExpand?: boolean | undefined;
+        stickyHeader?: boolean | undefined;
+        stickyOffset?: number | undefined;
+        globalItemsPerPage?: boolean | undefined;
+        group?: TableRowKeyData<T>;
+        groupExpandButtonPosition?: "end" | "start" | undefined;
+        collapsed?: T[] | undefined;
+        disabledRows?: T[] | undefined;
+        multiPageSelect?: boolean | undefined;
+        scroller?: HTMLElement | null | undefined;
+        itemClass?: string | ((item: T) => string) | undefined;
+    } & import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps;
+    expose(exposed: import('vue').ShallowUnwrapRef<{}>): void;
+    attrs: any;
+    slots: Readonly<Partial<Record<`header.${string}`, (props: {
+        column: TableColumn<T>;
+    }) => any> & Record<`item.${string}`, (props: {
+        column: TableColumn<T>;
+        row: T;
+        index: number;
+    }) => any> & {
+        'body.prepend': (props: {
+            colspan: number;
+        }) => any;
+        'body.append': (props: {
+            colspan: number;
+        }) => any;
+        'group.header': (props: {
+            colspan: number;
+            header: GroupHeader<T>;
+            isOpen: boolean;
+            toggle: () => void;
+        }) => any;
+        'group.header.content': (props: {
+            header: GroupHeader<T>;
+            groupKey: string;
+        }) => any;
+        'expanded-item': (props: {
+            row: T;
+            index: number;
+        }) => any;
+        'no-data': () => any;
+        'empty-description': () => any;
+        tfoot: () => any;
+    }>> & Partial<Record<`header.${string}`, (props: {
+        column: TableColumn<T>;
+    }) => any> & Record<`item.${string}`, (props: {
+        column: TableColumn<T>;
+        row: T;
+        index: number;
+    }) => any> & {
+        'body.prepend': (props: {
+            colspan: number;
+        }) => any;
+        'body.append': (props: {
+            colspan: number;
+        }) => any;
+        'group.header': (props: {
+            colspan: number;
+            header: GroupHeader<T>;
+            isOpen: boolean;
+            toggle: () => void;
+        }) => any;
+        'group.header.content': (props: {
+            header: GroupHeader<T>;
+            groupKey: string;
+        }) => any;
+        'expanded-item': (props: {
+            row: T;
+            index: number;
+        }) => any;
+        'no-data': () => any;
+        'empty-description': () => any;
+        tfoot: () => any;
+    }>;
+    emit: {
+        (e: 'update:model-value', value?: T[IdType][]): void;
+        (e: 'update:expanded', value: T[]): void;
+        (e: 'update:pagination', value: TablePaginationData): void;
+        (e: 'update:sort', value?: TableSortData<T>): void;
+        (e: 'update:options', value: TableOptions<T>): void;
+        (e: 'update:group', value?: GroupKeys<T>): void;
+        (e: 'update:collapsed', value?: T[]): void;
+        (e: 'copy:group', value: GroupData<T>): void;
+    };
+}>) => globalThis.VNode<import("vue").RendererNode, import("vue").RendererElement, {
+    [key: string]: any;
+}> & {
+    __ctx?: {
+        props: {
+            "onUpdate:model-value"?: ((value?: T[IdType][] | undefined) => any) | undefined;
+            "onUpdate:expanded"?: ((value: T[]) => any) | undefined;
+            "onUpdate:pagination"?: ((value: TablePaginationData) => any) | undefined;
+            "onUpdate:sort"?: ((value?: TableSortData<T>) => any) | undefined;
+            "onUpdate:options"?: ((value: TableOptions<T>) => any) | undefined;
+            "onUpdate:group"?: ((value?: GroupKeys<T>) => any) | undefined;
+            "onUpdate:collapsed"?: ((value?: T[] | undefined) => any) | undefined;
+            "onCopy:group"?: ((value: GroupData<T>) => any) | undefined;
+            rows: T[];
+            rowAttr: IdType;
+            modelValue?: T[IdType][] | undefined;
+            search?: string | undefined;
+            itemsPerPage?: number | undefined;
+            pagination?: TablePaginationData | undefined;
+            paginationModifiers?: {
+                external: boolean;
+            } | undefined;
+            sort?: TableSortData<T>;
+            sortModifiers?: {
+                external: boolean;
+            } | undefined;
+            cols?: TableColumn<T>[] | undefined;
+            columnAttr?: string | number | undefined;
+            dense?: boolean | undefined;
+            outlined?: boolean | undefined;
+            striped?: boolean | undefined;
+            loading?: boolean | undefined;
+            disablePerPage?: boolean | undefined;
+            empty?: {
+                label?: string | undefined;
+                description?: string | undefined;
+            } | undefined;
+            hideDefaultFooter?: boolean | undefined;
+            rounded?: "sm" | "md" | "lg" | undefined;
+            expanded?: T[] | undefined;
+            singleExpand?: boolean | undefined;
+            stickyHeader?: boolean | undefined;
+            stickyOffset?: number | undefined;
+            globalItemsPerPage?: boolean | undefined;
+            group?: TableRowKeyData<T>;
+            groupExpandButtonPosition?: "end" | "start" | undefined;
+            collapsed?: T[] | undefined;
+            disabledRows?: T[] | undefined;
+            multiPageSelect?: boolean | undefined;
+            scroller?: HTMLElement | null | undefined;
+            itemClass?: string | ((item: T) => string) | undefined;
+        } & import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps;
+        expose(exposed: import('vue').ShallowUnwrapRef<{}>): void;
+        attrs: any;
+        slots: Readonly<Partial<Record<`header.${string}`, (props: {
+            column: TableColumn<T>;
+        }) => any> & Record<`item.${string}`, (props: {
+            column: TableColumn<T>;
+            row: T;
+            index: number;
+        }) => any> & {
+            'body.prepend': (props: {
+                colspan: number;
+            }) => any;
+            'body.append': (props: {
+                colspan: number;
+            }) => any;
+            'group.header': (props: {
+                colspan: number;
+                header: GroupHeader<T>;
+                isOpen: boolean;
+                toggle: () => void;
+            }) => any;
+            'group.header.content': (props: {
+                header: GroupHeader<T>;
+                groupKey: string;
+            }) => any;
+            'expanded-item': (props: {
+                row: T;
+                index: number;
+            }) => any;
+            'no-data': () => any;
+            'empty-description': () => any;
+            tfoot: () => any;
+        }>> & Partial<Record<`header.${string}`, (props: {
+            column: TableColumn<T>;
+        }) => any> & Record<`item.${string}`, (props: {
+            column: TableColumn<T>;
+            row: T;
+            index: number;
+        }) => any> & {
+            'body.prepend': (props: {
+                colspan: number;
+            }) => any;
+            'body.append': (props: {
+                colspan: number;
+            }) => any;
+            'group.header': (props: {
+                colspan: number;
+                header: GroupHeader<T>;
+                isOpen: boolean;
+                toggle: () => void;
+            }) => any;
+            'group.header.content': (props: {
+                header: GroupHeader<T>;
+                groupKey: string;
+            }) => any;
+            'expanded-item': (props: {
+                row: T;
+                index: number;
+            }) => any;
+            'no-data': () => any;
+            'empty-description': () => any;
+            tfoot: () => any;
+        }>;
+        emit: {
+            (e: 'update:model-value', value?: T[IdType][]): void;
+            (e: 'update:expanded', value: T[]): void;
+            (e: 'update:pagination', value: TablePaginationData): void;
+            (e: 'update:sort', value?: TableSortData<T>): void;
+            (e: 'update:options', value: TableOptions<T>): void;
+            (e: 'update:group', value?: GroupKeys<T>): void;
+            (e: 'update:collapsed', value?: T[]): void;
+            (e: 'copy:group', value: GroupData<T>): void;
+        };
+    } | undefined;
+};
+export default _default;
+type __VLS_Prettify<T> = {
+    [K in keyof T]: T[K];
+} & {};

package/dist/components/tables/RuiExpandButton.vue.d.ts

@@ -0,0 +1,37 @@
+import type { RuiIcons } from '../../icons';
+export interface Props {
+    expanded: boolean;
+    icon?: RuiIcons;
+}
+declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<__VLS_WithDefaults<__VLS_TypePropsToOption<Props>, {
+    icon: string;
+}>, {}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<globalThis.ExtractPropTypes<__VLS_WithDefaults<__VLS_TypePropsToOption<Props>, {
+    icon: string;
+}>>>, {
+    icon: RuiIcons;
+}, {}>, {
+    default?(_: {}): any;
+}>;
+export default _default;
+type __VLS_WithDefaults<P, D> = {
+    [K in keyof Pick<P, keyof P>]: K extends keyof D ? __VLS_Prettify<P[K] & {
+        default: D[K];
+    }> : P[K];
+};
+type __VLS_Prettify<T> = {
+    [K in keyof T]: T[K];
+} & {};
+type __VLS_WithTemplateSlots<T, S> = T & {
+    new (): {
+        $slots: S;
+    };
+};
+type __VLS_NonUndefinedable<T> = T extends undefined ? never : T;
+type __VLS_TypePropsToOption<T> = {
+    [K in keyof T]-?: {} extends Pick<T, K> ? {
+        type: import('vue').PropType<__VLS_NonUndefinedable<T[K]>>;
+    } : {
+        type: import('vue').PropType<T[K]>;
+        required: true;
+    };
+};