@rotki/ui-library 0.4.0 → 0.5.1

package/dist/components/chips/Chip.vue.d.ts

@@ -1,6 +1,6 @@
 import { type ContextColorsType } from '../../consts/colors';
 export interface Props {
-    label: string;
+    label?: string;
     dismissible?: boolean;
     disabled?: boolean;
     size?: 'sm' | 'md';
@@ -22,7 +22,7 @@ declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<{
     };
     label: {
         type: globalThis.PropType<string>;
-        required: true;
+        default: string;
     };
     disabled: {
         type: globalThis.PropType<boolean>;
@@ -49,7 +49,7 @@ declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<{
     };
     label: {
         type: globalThis.PropType<string>;
-        required: true;
+        default: string;
     };
     disabled: {
         type: globalThis.PropType<boolean>;
@@ -65,6 +65,7 @@ declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<{
     variant: "outlined" | "filled";
     color: "grey" | "primary" | "secondary" | "error" | "warning" | "info" | "success";
     size: "sm" | "md";
+    label: string;
     disabled: boolean;
     dismissible: boolean;
 }, {}>, {

package/dist/components/index.d.ts

@@ -8,6 +8,7 @@ import { type Props as ChipProps, default as RuiChip } from '../components/chips
 import { default as RuiStepper } from '../components/steppers/Stepper.vue';
 import { default as RuiTextField } from '../components/forms/text-field/TextField.vue';
 import { default as RuiTooltip, type Props as TooltipProps } from '../components/overlays/tooltip/Tooltip.vue';
+import { type Props as BadgeProps, default as RuiBadge } from '../components/overlays/badge/Badge.vue';
 import { type Props as DialogProps, default as RuiDialog } from '../components/overlays/dialog/Dialog.vue';
 import { default as RuiFooterStepper } from '../components/steppers/FooterStepper.vue';
 import { default as RuiProgress } from '../components/progress/Progress.vue';
@@ -17,9 +18,10 @@ import { default as RuiRevealableTextField } from '../components/forms/revealabl
 import { default as RuiLogo } from '../components/logos/Logo.vue';
 import { default as RuiSimpleSelect, type Props as SimpleSelectProps } from '../components/forms/select/SimpleSelect.vue';
 import { type TableColumn as DataTableColumn, type TableOptions as DataTableOptions, type Props as DataTableProps, type SortColumn as DataTableSortColumn, default as RuiDataTable } from '../components/tables/DataTable.vue';
+import { type TablePaginationData } from '../components/tables/TablePagination.vue';
 import { type Props as CardProps, default as RuiCard } from '../components/cards/Card.vue';
 import { default as RuiTabs } from '../components/tabs/tabs/Tabs.vue';
 import { default as RuiTab } from '../components/tabs/tab/Tab.vue';
 import { default as RuiTabItems } from '../components/tabs/tab-items/TabItems.vue';
 import { default as RuiTabItem } from '../components/tabs/tab-item/TabItem.vue';
-export { RuiAlert, RuiAutoComplete, RuiButton, RuiButtonGroup, RuiCheckbox, RuiChip, RuiFooterStepper, RuiIcon, RuiLogo, RuiProgress, RuiRadio, RuiRadioGroup, RuiRevealableTextField, RuiStepper, RuiTextField, RuiTooltip, RuiDataTable, RuiSimpleSelect, RuiDialog, RuiCard, RuiTabs, RuiTab, RuiTabItems, RuiTabItem, AutoCompleteProps, ChipProps, TooltipProps, SimpleSelectProps, DataTableProps, DataTableColumn, DataTableSortColumn, DataTableOptions, DialogProps, ButtonProps, CardProps, };
+export { RuiAlert, RuiAutoComplete, RuiBadge, RuiButton, RuiButtonGroup, RuiCheckbox, RuiChip, RuiFooterStepper, RuiIcon, RuiLogo, RuiProgress, RuiRadio, RuiRadioGroup, RuiRevealableTextField, RuiStepper, RuiTextField, RuiTooltip, RuiDataTable, RuiSimpleSelect, RuiDialog, RuiCard, RuiTabs, RuiTab, RuiTabItems, RuiTabItem, AutoCompleteProps, ChipProps, TooltipProps, SimpleSelectProps, DataTableProps, DataTableColumn, DataTableSortColumn, DataTableOptions, TablePaginationData, DialogProps, ButtonProps, CardProps, BadgeProps, };

package/dist/components/index.es.js

@@ -1,4 +1,4 @@
-import { A as r, a as m, B as l, b as T, j as b, C as d, c as C, D as c, i as g, F as n, I as x, _ as F, P as I, R as S, d as h, e as A, h as B, f as D, l as f, n as k, m as G, k as P, g as j, T as v } from "../index-65c6da26.js";
+import { A as r, a as m, B as l, b as T, c as b, k as d, C as g, d as C, D as c, j as n, F as x, I as B, _ as F, P as I, R as S, e as h, f as A, i as D, g as f, m as k, o as G, n as P, l as j, h as v, T as L } from "../index-c62f6196.js";
 import "vue";
 import "@vueuse/shared";
 import "../index-393a0e94.js";
@@ -9,26 +9,27 @@ import "vue-router";
 export {
   r as RuiAlert,
   m as RuiAutoComplete,
-  l as RuiButton,
-  T as RuiButtonGroup,
-  b as RuiCard,
-  d as RuiCheckbox,
+  l as RuiBadge,
+  T as RuiButton,
+  b as RuiButtonGroup,
+  d as RuiCard,
+  g as RuiCheckbox,
   C as RuiChip,
   c as RuiDataTable,
-  g as RuiDialog,
-  n as RuiFooterStepper,
-  x as RuiIcon,
+  n as RuiDialog,
+  x as RuiFooterStepper,
+  B as RuiIcon,
   F as RuiLogo,
   I as RuiProgress,
   S as RuiRadio,
   h as RuiRadioGroup,
   A as RuiRevealableTextField,
-  B as RuiSimpleSelect,
-  D as RuiStepper,
-  f as RuiTab,
-  k as RuiTabItem,
-  G as RuiTabItems,
-  P as RuiTabs,
-  j as RuiTextField,
-  v as RuiTooltip
+  D as RuiSimpleSelect,
+  f as RuiStepper,
+  k as RuiTab,
+  G as RuiTabItem,
+  P as RuiTabItems,
+  j as RuiTabs,
+  v as RuiTextField,
+  L as RuiTooltip
 };

package/dist/components/overlays/badge/Badge.vue.d.ts

@@ -0,0 +1,128 @@
+import { type ContextColorsType } from '../../../consts/colors';
+import { type RuiIcons } from '~/src';
+export interface Props {
+    text?: string | null;
+    icon?: RuiIcons | null;
+    modelValue?: boolean;
+    dot?: boolean;
+    left?: boolean;
+    offsetX?: string | number;
+    offsetY?: string | number;
+    placement?: 'top' | 'center' | 'bottom';
+    size?: 'sm' | 'md' | 'lg';
+    rounded?: 'sm' | 'md' | 'lg' | 'full';
+    color?: 'default' | ContextColorsType;
+}
+declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<{
+    color: {
+        type: globalThis.PropType<"primary" | "secondary" | "error" | "warning" | "info" | "success" | "default">;
+        default: string;
+    };
+    size: {
+        type: globalThis.PropType<"sm" | "lg" | "md">;
+        default: string;
+    };
+    text: {
+        type: globalThis.PropType<string | null>;
+        default: null;
+    };
+    rounded: {
+        type: globalThis.PropType<"sm" | "lg" | "md" | "full">;
+        default: string;
+    };
+    icon: {
+        type: globalThis.PropType<RuiIcons | null>;
+        default: null;
+    };
+    modelValue: {
+        type: globalThis.PropType<boolean>;
+        default: boolean;
+    };
+    left: {
+        type: globalThis.PropType<boolean>;
+        default: boolean;
+    };
+    placement: {
+        type: globalThis.PropType<"center" | "top" | "bottom">;
+        default: string;
+    };
+    dot: {
+        type: globalThis.PropType<boolean>;
+        default: boolean;
+    };
+    offsetX: {
+        type: globalThis.PropType<string | number>;
+        default: number;
+    };
+    offsetY: {
+        type: globalThis.PropType<string | number>;
+        default: number;
+    };
+}, {}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{
+    color: {
+        type: globalThis.PropType<"primary" | "secondary" | "error" | "warning" | "info" | "success" | "default">;
+        default: string;
+    };
+    size: {
+        type: globalThis.PropType<"sm" | "lg" | "md">;
+        default: string;
+    };
+    text: {
+        type: globalThis.PropType<string | null>;
+        default: null;
+    };
+    rounded: {
+        type: globalThis.PropType<"sm" | "lg" | "md" | "full">;
+        default: string;
+    };
+    icon: {
+        type: globalThis.PropType<RuiIcons | null>;
+        default: null;
+    };
+    modelValue: {
+        type: globalThis.PropType<boolean>;
+        default: boolean;
+    };
+    left: {
+        type: globalThis.PropType<boolean>;
+        default: boolean;
+    };
+    placement: {
+        type: globalThis.PropType<"center" | "top" | "bottom">;
+        default: string;
+    };
+    dot: {
+        type: globalThis.PropType<boolean>;
+        default: boolean;
+    };
+    offsetX: {
+        type: globalThis.PropType<string | number>;
+        default: number;
+    };
+    offsetY: {
+        type: globalThis.PropType<string | number>;
+        default: number;
+    };
+}>>, {
+    color: "primary" | "secondary" | "error" | "warning" | "info" | "success" | "default";
+    size: "sm" | "lg" | "md";
+    text: string | null;
+    rounded: "sm" | "lg" | "md" | "full";
+    icon: RuiIcons | null;
+    modelValue: boolean;
+    left: boolean;
+    placement: "center" | "top" | "bottom";
+    dot: boolean;
+    offsetX: string | number;
+    offsetY: string | number;
+}, {}>, {
+    default?(_: {}): any;
+    badge?(_: {}): any;
+    icon?(_: {}): any;
+}>;
+export default _default;
+type __VLS_WithTemplateSlots<T, S> = T & {
+    new (): {
+        $slots: S;
+    };
+};

package/dist/components/overlays/tooltip/Tooltip.vue.d.ts

@@ -17,10 +17,6 @@ declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<{
         type: globalThis.PropType<boolean>;
         default: boolean;
     };
-    popper: {
-        type: globalThis.PropType<PopperOptions>;
-        default: () => {};
-    };
     hideArrow: {
         type: globalThis.PropType<boolean>;
         default: boolean;
@@ -33,6 +29,10 @@ declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<{
         type: globalThis.PropType<number>;
         default: number;
     };
+    popper: {
+        type: globalThis.PropType<PopperOptions>;
+        default: () => {};
+    };
     tooltipClass: {
         type: globalThis.PropType<string>;
         default: string;
@@ -46,10 +46,6 @@ declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<{
         type: globalThis.PropType<boolean>;
         default: boolean;
     };
-    popper: {
-        type: globalThis.PropType<PopperOptions>;
-        default: () => {};
-    };
     hideArrow: {
         type: globalThis.PropType<boolean>;
         default: boolean;
@@ -62,6 +58,10 @@ declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<{
         type: globalThis.PropType<number>;
         default: number;
     };
+    popper: {
+        type: globalThis.PropType<PopperOptions>;
+        default: () => {};
+    };
     tooltipClass: {
         type: globalThis.PropType<string>;
         default: string;
@@ -69,10 +69,10 @@ declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<{
 }>>, {
     text: string | null;
     disabled: boolean;
-    popper: PopperOptions;
     hideArrow: boolean;
     openDelay: number;
     closeDelay: number;
+    popper: PopperOptions;
     tooltipClass: string;
 }, {}>, {
     activator?(_: {

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

@@ -1,38 +1,77 @@
 import { type TablePaginationData } from './TablePagination.vue';
-export interface TableColumn {
-    key: string;
-    sortable?: boolean;
+/**
+ * Represents a sortable column name for a given type.
+ * The column name must be a key of the passed data object type.
+ * @template T - The type of the data in the column.
+ */
+export type SortableColumnName<T> = keyof T;
+/**
+ * Represents the name of a column in a dataset.
+ *
+ * The `ColumnName` type can either be a `SortableColumnName` or a string.
+ *
+ * @typeparam T - The type of the dataset containing the column name.
+ */
+export type ColumnName<T> = SortableColumnName<T> | string;
+export interface BaseTableColumn {
     direction?: 'asc' | 'desc';
     align?: 'start' | 'center' | 'end';
     class?: string;
     cellClass?: string;
     [key: string]: any;
 }
-export interface SortColumn {
-    column?: string;
+/**
+ * Represents a sortable table column.
+ * This is used to ensure that when using sortable with a true value,
+ * the key matches to an actual property of the object passed.
+ *
+ * @template T - The type of data in the table column.
+ */
+export interface SortableTableColumn<T> extends BaseTableColumn {
+    key: SortableColumnName<T>;
+    sortable: true;
+}
+/**
+ * An interface representing a column in a table that cannot be sorted.
+ * This can be mapped to an actual property of the object or to a virtual column.
+ *
+ * @typeparam T - The type of data in the table.
+ */
+export interface NoneSortableTableColumn<T> extends BaseTableColumn {
+    key: string | SortableColumnName<T>;
+    sortable?: false;
+}
+export type TableColumn<T> = SortableTableColumn<T> | NoneSortableTableColumn<T>;
+export interface SortColumn<T> {
+    column?: SortableColumnName<T>;
     direction: 'asc' | 'desc';
 }
-export interface TableOptions {
+export interface TableOptions<T> {
     pagination?: TablePaginationData;
-    sort?: SortColumn | SortColumn[];
+    sort?: SortColumn<T> | SortColumn<T>[];
 }
-export interface Props {
+export interface Props<T, K extends keyof T> {
     /**
      * list of items for each row
      */
-    rows: Array<Record<string, any>>;
+    rows: T[];
     /**
      * the attribute used to identify each row uniquely for selection, usually `id`
      */
-    rowAttr: string;
+    rowAttr: K;
     /**
      * model for selected rows, add a v-model to support row selection
      */
-    modelValue?: string[];
+    modelValue?: T[K][];
     /**
-     * model for insternal searching
+     * 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 }"
@@ -53,7 +92,7 @@ export interface Props {
      * multi columns sort
      * @example v-model:sort="[{ column: 'name', direction: 'asc' }]"
      */
-    sort?: SortColumn | SortColumn[];
+    sort?: SortColumn<T> | SortColumn<T>[];
     /**
      * modifiers for specifying externally sorted tables
      * use this when api controls sorting
@@ -68,7 +107,7 @@ export interface Props {
     /**
      * list of column definitions
      */
-    cols?: Array<TableColumn>;
+    cols?: TableColumn<T>[];
     /**
      * attribute to use from column definitions to display column titles
      */
@@ -95,187 +134,78 @@ export interface Props {
         label?: string;
         description?: string;
     };
+    /**
+     * should hide the footer
+     */
+    hideDefaultFooter?: boolean;
+    rounded?: 'sm' | 'md' | 'lg';
 }
-declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<{
-    sort: {
-        type: globalThis.PropType<SortColumn | SortColumn[]>;
-        default: undefined;
-    };
-    search: {
-        type: globalThis.PropType<string>;
-        default: string;
-    };
-    outlined: {
-        type: globalThis.PropType<boolean>;
-    };
-    loading: {
-        type: globalThis.PropType<boolean>;
-        default: boolean;
-    };
-    modelValue: {
-        type: globalThis.PropType<string[]>;
-        default: undefined;
-    };
-    dense: {
-        type: globalThis.PropType<boolean>;
-    };
-    empty: {
-        type: globalThis.PropType<{
-            label?: string | undefined;
-            description?: string | undefined;
-        }>;
-        default: () => {
-            label: string;
+declare const _default: <T extends object, IdType extends keyof T = keyof T>(__VLS_props: Props<T, IdType> & import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, __VLS_ctx?: Pick<{
+    props: Props<T, IdType>;
+    expose(exposed: {}): void;
+    attrs: any;
+    slots: Partial<Record<string, (_: {
+        column: TableColumn<T>;
+    }) => any>> & Partial<Record<string, (_: {
+        column: TableColumn<T>;
+        row: T;
+        index: number;
+    }) => any>> & {
+        "no-data"?(_: {}): any;
+        "empty-description"?(_: {}): any;
+        tfoot?(_: {}): any;
+    };
+    emit: {
+        (e: 'update:model-value', value?: T[IdType][] | undefined): void;
+        (e: 'update:pagination', value: TablePaginationData): void;
+        (e: 'update:sort', value?: SortColumn<T> | SortColumn<T>[] | undefined): void;
+        (e: 'update:options', value: TableOptions<T>): void;
+    };
+}, "attrs" | "slots" | "emit"> | undefined, __VLS_expose?: ((exposed: {}) => void) | undefined, __VLS_setup?: Promise<{
+    props: Props<T, IdType>;
+    expose(exposed: {}): void;
+    attrs: any;
+    slots: Partial<Record<string, (_: {
+        column: TableColumn<T>;
+    }) => any>> & Partial<Record<string, (_: {
+        column: TableColumn<T>;
+        row: T;
+        index: number;
+    }) => any>> & {
+        "no-data"?(_: {}): any;
+        "empty-description"?(_: {}): any;
+        tfoot?(_: {}): any;
+    };
+    emit: {
+        (e: 'update:model-value', value?: T[IdType][] | undefined): void;
+        (e: 'update:pagination', value: TablePaginationData): void;
+        (e: 'update:sort', value?: SortColumn<T> | SortColumn<T>[] | undefined): void;
+        (e: 'update:options', value: TableOptions<T>): void;
+    };
+}>) => globalThis.VNode<import("vue").RendererNode, import("vue").RendererElement, {
+    [key: string]: any;
+}> & {
+    __ctx?: {
+        props: Props<T, IdType>;
+        expose(exposed: {}): void;
+        attrs: any;
+        slots: Partial<Record<string, (_: {
+            column: TableColumn<T>;
+        }) => any>> & Partial<Record<string, (_: {
+            column: TableColumn<T>;
+            row: T;
+            index: number;
+        }) => any>> & {
+            "no-data"?(_: {}): any;
+            "empty-description"?(_: {}): any;
+            tfoot?(_: {}): any;
         };
-    };
-    rows: {
-        type: globalThis.PropType<Record<string, any>[]>;
-        required: true;
-    };
-    rowAttr: {
-        type: globalThis.PropType<string>;
-        required: true;
-    };
-    pagination: {
-        type: globalThis.PropType<TablePaginationData>;
-        default: undefined;
-    };
-    paginationModifiers: {
-        type: globalThis.PropType<{
-            external: boolean;
-        }>;
-        default: undefined;
-    };
-    sortModifiers: {
-        type: globalThis.PropType<{
-            external: boolean;
-        }>;
-        default: undefined;
-    };
-    cols: {
-        type: globalThis.PropType<TableColumn[]>;
-        default: undefined;
-    };
-    columnAttr: {
-        type: globalThis.PropType<string>;
-        default: string;
-    };
-}, {}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
-    "update:model-value": (value?: string[] | undefined) => void;
-    "update:pagination": (value?: TablePaginationData | undefined) => void;
-    "update:sort": (value?: SortColumn | SortColumn[] | undefined) => void;
-    "update:options": (value?: TableOptions | undefined) => void;
-}, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{
-    sort: {
-        type: globalThis.PropType<SortColumn | SortColumn[]>;
-        default: undefined;
-    };
-    search: {
-        type: globalThis.PropType<string>;
-        default: string;
-    };
-    outlined: {
-        type: globalThis.PropType<boolean>;
-    };
-    loading: {
-        type: globalThis.PropType<boolean>;
-        default: boolean;
-    };
-    modelValue: {
-        type: globalThis.PropType<string[]>;
-        default: undefined;
-    };
-    dense: {
-        type: globalThis.PropType<boolean>;
-    };
-    empty: {
-        type: globalThis.PropType<{
-            label?: string | undefined;
-            description?: string | undefined;
-        }>;
-        default: () => {
-            label: string;
+        emit: {
+            (e: 'update:model-value', value?: T[IdType][] | undefined): void;
+            (e: 'update:pagination', value: TablePaginationData): void;
+            (e: 'update:sort', value?: SortColumn<T> | SortColumn<T>[] | undefined): void;
+            (e: 'update:options', value: TableOptions<T>): void;
         };
-    };
-    rows: {
-        type: globalThis.PropType<Record<string, any>[]>;
-        required: true;
-    };
-    rowAttr: {
-        type: globalThis.PropType<string>;
-        required: true;
-    };
-    pagination: {
-        type: globalThis.PropType<TablePaginationData>;
-        default: undefined;
-    };
-    paginationModifiers: {
-        type: globalThis.PropType<{
-            external: boolean;
-        }>;
-        default: undefined;
-    };
-    sortModifiers: {
-        type: globalThis.PropType<{
-            external: boolean;
-        }>;
-        default: undefined;
-    };
-    cols: {
-        type: globalThis.PropType<TableColumn[]>;
-        default: undefined;
-    };
-    columnAttr: {
-        type: globalThis.PropType<string>;
-        default: string;
-    };
-}>> & {
-    "onUpdate:model-value"?: ((value?: string[] | undefined) => any) | undefined;
-    "onUpdate:pagination"?: ((value?: TablePaginationData | undefined) => any) | undefined;
-    "onUpdate:sort"?: ((value?: SortColumn | SortColumn[] | undefined) => any) | undefined;
-    "onUpdate:options"?: ((value?: TableOptions | undefined) => any) | undefined;
-}, {
-    sort: SortColumn | SortColumn[];
-    search: string;
-    loading: boolean;
-    modelValue: string[];
-    empty: {
-        label?: string | undefined;
-        description?: string | undefined;
-    };
-    pagination: TablePaginationData;
-    paginationModifiers: {
-        external: boolean;
-    };
-    sortModifiers: {
-        external: boolean;
-    };
-    cols: TableColumn[];
-    columnAttr: string;
-}, {}>, Partial<Record<string, (_: {
-    column: TableColumn | {
-        [x: string]: string | boolean;
-        key: string;
-        sortable: boolean;
-        class: string;
-    };
-}) => any>> & Partial<Record<string, (_: {
-    column: TableColumn | {
-        [x: string]: string | boolean;
-        key: string;
-        sortable: boolean;
-        class: string;
-    };
-    row: Record<string, any>;
-    index: number;
-}) => any>> & {
-    "no-data"?(_: {}): any;
-    "empty-description"?(_: {}): any;
-    tfoot?(_: {}): any;
-}>;
-export default _default;
-type __VLS_WithTemplateSlots<T, S> = T & {
-    new (): {
-        $slots: S;
-    };
+    } | undefined;
 };
+export default _default;