@rockrms/obsidian-framework 18.1.0 → 19.1.8

package/types/Controls/Grid/Columns/highlightDetailColumn.partial.d.ts

@@ -1,5 +1,5 @@
 import { Component, PropType } from "vue";
-import { ColumnDefinition, ExportValueFunction, IGridState, QuickFilterValueFunction } from "@Obsidian/Types/Controls/grid";
+import { ColumnDefinition, ExportValueFunction, FilterValueFunction, IGridState, QuickFilterValueFunction } from "@Obsidian/Types/Controls/grid";
 /**
  * Gets the value to use when exporting a cell of this column.
  *
@@ -10,7 +10,9 @@ import { ColumnDefinition, ExportValueFunction, IGridState, QuickFilterValueFunc
  */
 declare function getExportValue(row: Record<string, unknown>, column: ColumnDefinition): string | undefined;
 /**
- * Gets the value to use when quick filtering a cell of this column.
+ * Gets the combined title + detail text to use when filtering a cell of this
+ * column. Used for both the grid-wide quick filter and the per-column filter
+ * so that searches match either line of the cell.
  *
  * @param row The row that will be filtered.
  * @param column The column that will be filtered.
@@ -18,63 +20,23 @@ declare function getExportValue(row: Record<string, unknown>, column: ColumnDefi
  *
  * @returns A string value or undefined if the cell has no value.
  */
-declare function getQuickFilterValue(row: Record<string, unknown>, column: ColumnDefinition, grid: IGridState): string | undefined;
+declare function getCombinedFilterValue(row: Record<string, unknown>, column: ColumnDefinition, grid: IGridState): string | undefined;
 declare const _default: import("vue").DefineComponent<{
     formatComponent: {
         type: PropType<Component>;
-        default: import("vue").DefineComponent<{
-            column: {
-                type: PropType<ColumnDefinition>;
-                required: true;
-            };
-            row: {
-                type: PropType<Record<string, unknown>>;
-                required: true;
-            };
-            grid: {
-                type: PropType<IGridState>;
-                required: true;
-            };
-        }, {}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{
-            column: {
-                type: PropType<ColumnDefinition>;
-                required: true;
-            };
-            row: {
-                type: PropType<Record<string, unknown>>;
-                required: true;
-            };
-            grid: {
-                type: PropType<IGridState>;
-                required: true;
-            };
-        }>>, {}, {}>;
+        default: import("vue").DefineComponent<import("@Obsidian/Types/Controls/grid").StandardCellProps, {}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<import("@Obsidian/Types/Controls/grid").StandardCellProps>>, {}, {}>;
     };
     skeletonComponent: {
         type: PropType<Component>;
-        default: import("vue").DefineComponent<{
-            column: {
-                type: PropType<ColumnDefinition>;
-                required: true;
-            };
-            grid: {
-                type: PropType<IGridState>;
-                required: true;
-            };
-        }, {}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{
-            column: {
-                type: PropType<ColumnDefinition>;
-                required: true;
-            };
-            grid: {
-                type: PropType<IGridState>;
-                required: true;
-            };
-        }>>, {}, {}>;
+        default: import("vue").DefineComponent<import("@Obsidian/Types/Controls/grid").StandardSkeletonCellProps, {}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<import("@Obsidian/Types/Controls/grid").StandardSkeletonCellProps>>, {}, {}>;
     };
     quickFilterValue: {
-        type: PropType<QuickFilterValueFunction>;
-        default: typeof getQuickFilterValue;
+        type: PropType<QuickFilterValueFunction | string>;
+        default: typeof getCombinedFilterValue;
+    };
+    filterValue: {
+        type: PropType<FilterValueFunction | string>;
+        default: typeof getCombinedFilterValue;
     };
     exportValue: {
         type: PropType<ExportValueFunction>;
@@ -106,17 +68,13 @@ declare const _default: import("vue").DefineComponent<{
         required: false;
     };
     sortValue: {
-        type: PropType<string | import("@Obsidian/Types/Controls/grid").SortValueFunction>;
+        type: PropType<(import("@Obsidian/Types/Controls/grid").SortValueFunction | string)>;
         required: false;
     };
     filter: {
         type: PropType<import("@Obsidian/Types/Controls/grid").ColumnFilter>;
         required: false;
     };
-    filterValue: {
-        type: PropType<string | import("@Obsidian/Types/Controls/grid").FilterValueFunction>;
-        required: false;
-    };
     filterValues: {
         type: PropType<import("@Obsidian/Types/Controls/grid").FilterValuesFunction>;
         required: false;
@@ -142,7 +100,7 @@ declare const _default: import("vue").DefineComponent<{
         required: false;
     };
     visiblePriority: {
-        type: PropType<"xs" | "sm" | "lg" | "md" | "xl">;
+        type: PropType<"xs" | "sm" | "md" | "lg" | "xl">;
         default: "xs";
     };
     width: {
@@ -168,59 +126,19 @@ declare const _default: import("vue").DefineComponent<{
 }, unknown, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{
     formatComponent: {
         type: PropType<Component>;
-        default: import("vue").DefineComponent<{
-            column: {
-                type: PropType<ColumnDefinition>;
-                required: true;
-            };
-            row: {
-                type: PropType<Record<string, unknown>>;
-                required: true;
-            };
-            grid: {
-                type: PropType<IGridState>;
-                required: true;
-            };
-        }, {}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{
-            column: {
-                type: PropType<ColumnDefinition>;
-                required: true;
-            };
-            row: {
-                type: PropType<Record<string, unknown>>;
-                required: true;
-            };
-            grid: {
-                type: PropType<IGridState>;
-                required: true;
-            };
-        }>>, {}, {}>;
+        default: import("vue").DefineComponent<import("@Obsidian/Types/Controls/grid").StandardCellProps, {}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<import("@Obsidian/Types/Controls/grid").StandardCellProps>>, {}, {}>;
     };
     skeletonComponent: {
         type: PropType<Component>;
-        default: import("vue").DefineComponent<{
-            column: {
-                type: PropType<ColumnDefinition>;
-                required: true;
-            };
-            grid: {
-                type: PropType<IGridState>;
-                required: true;
-            };
-        }, {}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{
-            column: {
-                type: PropType<ColumnDefinition>;
-                required: true;
-            };
-            grid: {
-                type: PropType<IGridState>;
-                required: true;
-            };
-        }>>, {}, {}>;
+        default: import("vue").DefineComponent<import("@Obsidian/Types/Controls/grid").StandardSkeletonCellProps, {}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<import("@Obsidian/Types/Controls/grid").StandardSkeletonCellProps>>, {}, {}>;
     };
     quickFilterValue: {
-        type: PropType<QuickFilterValueFunction>;
-        default: typeof getQuickFilterValue;
+        type: PropType<QuickFilterValueFunction | string>;
+        default: typeof getCombinedFilterValue;
+    };
+    filterValue: {
+        type: PropType<FilterValueFunction | string>;
+        default: typeof getCombinedFilterValue;
     };
     exportValue: {
         type: PropType<ExportValueFunction>;
@@ -252,17 +170,13 @@ declare const _default: import("vue").DefineComponent<{
         required: false;
     };
     sortValue: {
-        type: PropType<string | import("@Obsidian/Types/Controls/grid").SortValueFunction>;
+        type: PropType<(import("@Obsidian/Types/Controls/grid").SortValueFunction | string)>;
         required: false;
     };
     filter: {
         type: PropType<import("@Obsidian/Types/Controls/grid").ColumnFilter>;
         required: false;
     };
-    filterValue: {
-        type: PropType<string | import("@Obsidian/Types/Controls/grid").FilterValueFunction>;
-        required: false;
-    };
     filterValues: {
         type: PropType<import("@Obsidian/Types/Controls/grid").FilterValuesFunction>;
         required: false;
@@ -288,7 +202,7 @@ declare const _default: import("vue").DefineComponent<{
         required: false;
     };
     visiblePriority: {
-        type: PropType<"xs" | "sm" | "lg" | "md" | "xl">;
+        type: PropType<"xs" | "sm" | "md" | "lg" | "xl">;
         default: "xs";
     };
     width: {
@@ -313,7 +227,8 @@ declare const _default: import("vue").DefineComponent<{
     };
 }>>, {
     name: string;
-    quickFilterValue: QuickFilterValueFunction;
+    quickFilterValue: string | QuickFilterValueFunction;
+    filterValue: string | FilterValueFunction;
     formatComponent: Component;
     exportValue: ExportValueFunction;
     skeletonComponent: Component;

package/types/Controls/Grid/Columns/htmlColumn.partial.d.ts

@@ -71,25 +71,7 @@ declare const _default: import("vue").DefineComponent<{
     };
     skeletonComponent: {
         type: PropType<Component>;
-        default: import("vue").DefineComponent<{
-            column: {
-                type: PropType<ColumnDefinition>;
-                required: true;
-            };
-            grid: {
-                type: PropType<IGridState>;
-                required: true;
-            };
-        }, {}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{
-            column: {
-                type: PropType<ColumnDefinition>;
-                required: true;
-            };
-            grid: {
-                type: PropType<IGridState>;
-                required: true;
-            };
-        }>>, {}, {}>;
+        default: import("vue").DefineComponent<import("@Obsidian/Types/Controls/grid").StandardSkeletonCellProps, {}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<import("@Obsidian/Types/Controls/grid").StandardSkeletonCellProps>>, {}, {}>;
     };
     filterValue: {
         type: PropType<FilterValueFunction>;
@@ -128,7 +110,7 @@ declare const _default: import("vue").DefineComponent<{
         required: false;
     };
     sortValue: {
-        type: PropType<string | import("@Obsidian/Types/Controls/grid").SortValueFunction>;
+        type: PropType<(import("@Obsidian/Types/Controls/grid").SortValueFunction | string)>;
         required: false;
     };
     filter: {
@@ -160,7 +142,7 @@ declare const _default: import("vue").DefineComponent<{
         required: false;
     };
     visiblePriority: {
-        type: PropType<"xs" | "sm" | "lg" | "md" | "xl">;
+        type: PropType<"xs" | "sm" | "md" | "lg" | "xl">;
         default: "xs";
     };
     width: {
@@ -220,25 +202,7 @@ declare const _default: import("vue").DefineComponent<{
     };
     skeletonComponent: {
         type: PropType<Component>;
-        default: import("vue").DefineComponent<{
-            column: {
-                type: PropType<ColumnDefinition>;
-                required: true;
-            };
-            grid: {
-                type: PropType<IGridState>;
-                required: true;
-            };
-        }, {}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{
-            column: {
-                type: PropType<ColumnDefinition>;
-                required: true;
-            };
-            grid: {
-                type: PropType<IGridState>;
-                required: true;
-            };
-        }>>, {}, {}>;
+        default: import("vue").DefineComponent<import("@Obsidian/Types/Controls/grid").StandardSkeletonCellProps, {}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<import("@Obsidian/Types/Controls/grid").StandardSkeletonCellProps>>, {}, {}>;
     };
     filterValue: {
         type: PropType<FilterValueFunction>;
@@ -277,7 +241,7 @@ declare const _default: import("vue").DefineComponent<{
         required: false;
     };
     sortValue: {
-        type: PropType<string | import("@Obsidian/Types/Controls/grid").SortValueFunction>;
+        type: PropType<(import("@Obsidian/Types/Controls/grid").SortValueFunction | string)>;
         required: false;
     };
     filter: {
@@ -309,7 +273,7 @@ declare const _default: import("vue").DefineComponent<{
         required: false;
     };
     visiblePriority: {
-        type: PropType<"xs" | "sm" | "lg" | "md" | "xl">;
+        type: PropType<"xs" | "sm" | "md" | "lg" | "xl">;
         default: "xs";
     };
     width: {
@@ -330,8 +294,8 @@ declare const _default: import("vue").DefineComponent<{
     };
 }>>, {
     name: string;
-    filterValue: FilterValueFunction;
     quickFilterValue: QuickFilterValueFunction;
+    filterValue: FilterValueFunction;
     formatComponent: Component;
     exportValue: ExportValueFunction;
     skeletonComponent: Component;

package/types/Controls/Grid/Columns/labelColumn.partial.d.ts

@@ -28,62 +28,18 @@ declare function getFilterValues(row: Record<string, unknown>, column: ColumnDef
 declare const _default: import("vue").DefineComponent<{
     formatComponent: {
         type: PropType<Component>;
-        default: import("vue").DefineComponent<{
-            column: {
-                type: PropType<ColumnDefinition>;
-                required: true;
-            };
-            row: {
-                type: PropType<Record<string, unknown>>;
-                required: true;
-            };
-            grid: {
-                type: PropType<import("@Obsidian/Types/Controls/grid").IGridState>;
-                required: true;
-            };
-        }, {}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{
-            column: {
-                type: PropType<ColumnDefinition>;
-                required: true;
-            };
-            row: {
-                type: PropType<Record<string, unknown>>;
-                required: true;
-            };
-            grid: {
-                type: PropType<import("@Obsidian/Types/Controls/grid").IGridState>;
-                required: true;
-            };
-        }>>, {}, {}>;
+        default: import("vue").DefineComponent<import("@Obsidian/Types/Controls/grid").StandardCellProps, {}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<import("@Obsidian/Types/Controls/grid").StandardCellProps>>, {}, {}>;
     };
     skeletonComponent: {
         type: PropType<Component>;
-        default: import("vue").DefineComponent<{
-            column: {
-                type: PropType<ColumnDefinition>;
-                required: true;
-            };
-            grid: {
-                type: PropType<import("@Obsidian/Types/Controls/grid").IGridState>;
-                required: true;
-            };
-        }, {}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{
-            column: {
-                type: PropType<ColumnDefinition>;
-                required: true;
-            };
-            grid: {
-                type: PropType<import("@Obsidian/Types/Controls/grid").IGridState>;
-                required: true;
-            };
-        }>>, {}, {}>;
+        default: import("vue").DefineComponent<import("@Obsidian/Types/Controls/grid").StandardSkeletonCellProps, {}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<import("@Obsidian/Types/Controls/grid").StandardSkeletonCellProps>>, {}, {}>;
     };
     quickFilterValue: {
-        type: PropType<string | QuickFilterValueFunction>;
+        type: PropType<QuickFilterValueFunction | string>;
         default: typeof getTextValue;
     };
     filterValue: {
-        type: PropType<string | FilterValueFunction>;
+        type: PropType<FilterValueFunction | string>;
         default: typeof getTextValue;
     };
     filterValues: {
@@ -184,7 +140,7 @@ declare const _default: import("vue").DefineComponent<{
         required: false;
     };
     visiblePriority: {
-        type: PropType<"xs" | "sm" | "lg" | "md" | "xl">;
+        type: PropType<"xs" | "sm" | "md" | "lg" | "xl">;
         default: "xs";
     };
     width: {
@@ -206,62 +162,18 @@ declare const _default: import("vue").DefineComponent<{
 }, unknown, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{
     formatComponent: {
         type: PropType<Component>;
-        default: import("vue").DefineComponent<{
-            column: {
-                type: PropType<ColumnDefinition>;
-                required: true;
-            };
-            row: {
-                type: PropType<Record<string, unknown>>;
-                required: true;
-            };
-            grid: {
-                type: PropType<import("@Obsidian/Types/Controls/grid").IGridState>;
-                required: true;
-            };
-        }, {}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{
-            column: {
-                type: PropType<ColumnDefinition>;
-                required: true;
-            };
-            row: {
-                type: PropType<Record<string, unknown>>;
-                required: true;
-            };
-            grid: {
-                type: PropType<import("@Obsidian/Types/Controls/grid").IGridState>;
-                required: true;
-            };
-        }>>, {}, {}>;
+        default: import("vue").DefineComponent<import("@Obsidian/Types/Controls/grid").StandardCellProps, {}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<import("@Obsidian/Types/Controls/grid").StandardCellProps>>, {}, {}>;
     };
     skeletonComponent: {
         type: PropType<Component>;
-        default: import("vue").DefineComponent<{
-            column: {
-                type: PropType<ColumnDefinition>;
-                required: true;
-            };
-            grid: {
-                type: PropType<import("@Obsidian/Types/Controls/grid").IGridState>;
-                required: true;
-            };
-        }, {}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{
-            column: {
-                type: PropType<ColumnDefinition>;
-                required: true;
-            };
-            grid: {
-                type: PropType<import("@Obsidian/Types/Controls/grid").IGridState>;
-                required: true;
-            };
-        }>>, {}, {}>;
+        default: import("vue").DefineComponent<import("@Obsidian/Types/Controls/grid").StandardSkeletonCellProps, {}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<import("@Obsidian/Types/Controls/grid").StandardSkeletonCellProps>>, {}, {}>;
     };
     quickFilterValue: {
-        type: PropType<string | QuickFilterValueFunction>;
+        type: PropType<QuickFilterValueFunction | string>;
         default: typeof getTextValue;
     };
     filterValue: {
-        type: PropType<string | FilterValueFunction>;
+        type: PropType<FilterValueFunction | string>;
         default: typeof getTextValue;
     };
     filterValues: {
@@ -362,7 +274,7 @@ declare const _default: import("vue").DefineComponent<{
         required: false;
     };
     visiblePriority: {
-        type: PropType<"xs" | "sm" | "lg" | "md" | "xl">;
+        type: PropType<"xs" | "sm" | "md" | "lg" | "xl">;
         default: "xs";
     };
     width: {
@@ -383,8 +295,8 @@ declare const _default: import("vue").DefineComponent<{
     };
 }>>, {
     name: string;
-    filterValue: string | FilterValueFunction;
     quickFilterValue: string | QuickFilterValueFunction;
+    filterValue: string | FilterValueFunction;
     formatComponent: Component;
     exportValue: ExportValueFunction;
     sortValue: SortValueFunction;