@turquoisehealth/pit-viper 2.65.1 → 2.66.1-dev.0

package/pv-components/dist/vue/tables/pv-components-tables.d.ts

@@ -3,6 +3,7 @@ import { Column } from 'ag-grid-enterprise';
 import { ColumnMovedEvent } from 'ag-grid-enterprise';
 import { ColumnResizedEvent } from 'ag-grid-enterprise';
 import { ColumnRowGroupChangedEvent } from 'ag-grid-enterprise';
+import { Component } from 'vue';
 import { ComputedRef } from 'vue';
 import { FilterChangedEvent } from 'ag-grid-enterprise';
 import { FilterModel } from 'ag-grid-enterprise';
@@ -45,6 +46,26 @@ export declare interface FocusUpdateEvent {
     filterField?: string | null | undefined;
 }
 
+declare interface MenuOption {
+    id: string;
+    text: string;
+    subText?: string;
+    secondaryText?: string | number;
+    icon?: string;
+    companyName?: string;
+    avatar?: {
+        initials?: string;
+        image?: string;
+        icon?: boolean;
+    };
+    groupingLabel?: string;
+    disabled?: boolean;
+    renderer?: Component;
+    rendererProps?: any;
+    classList?: string[];
+    searchText?: string;
+}
+
 export declare const PvDataTable: <T>(__VLS_props: NonNullable<Awaited<typeof __VLS_setup>>["props"], __VLS_ctx?: __VLS_PrettifyLocal<Pick<NonNullable<Awaited<typeof __VLS_setup>>, "attrs" | "emit" | "slots">>, __VLS_expose?: NonNullable<Awaited<typeof __VLS_setup>>["expose"], __VLS_setup?: Promise<{
     props: __VLS_PrettifyLocal<any & PvDataTableProps<T> & Partial<{}>> & PublicProps;
     expose(exposed: ShallowUnwrapRef<PvDataTablePublicInterface>): void;
@@ -83,6 +104,10 @@ declare interface PvDataTableProps<T> {
      * Handler to fetch filter values for server-side filtering. Only used for server-side row model.
      */
     filterValuesSetHandler?: (params: FilterValuesSetHandlerParams<T>) => Promise<(FilterValueResponseOption | null)[]>;
+    /**
+     * Handler to return suggestions for applying search terms to the table.
+     */
+    tableSearchHandler?: (params: TableSearchHandlerParams<T>) => Promise<(QueryBuilderSuggestionMenuOption | null)[]>;
     /**
      * Specifies an initial set of filters/groups/sort/etc. to be applied to the table.
      */
@@ -123,6 +148,10 @@ declare interface PvDataTableProps<T> {
      * Display button to group by columns
      */
     enableGroupBySelector?: boolean;
+    /**
+     * Display input to search within the table
+     */
+    enableTableSearch?: boolean;
     /**
      * Display button to open the vertical filter drawer
      */
@@ -219,6 +248,8 @@ declare interface PvDataTableProps<T> {
      * List of column fields that can be focused
      */
     focusableColumns?: string[];
+    tableSearchPlaceholder?: string;
+    tableSearchStyle?: TableSearchStyle;
 }
 
 declare interface PvDataTablePublicInterface {
@@ -229,4 +260,23 @@ declare interface PvDataTablePublicInterface {
     availableAggFuncColumns: ComputedRef<ColDef[]>;
 }
 
+declare interface QueryBuilderSuggestionMenuOption extends MenuOption {
+    queryTerm?: QueryTerm;
+}
+
+declare interface QueryTerm {
+    queryField?: string;
+    queryDisplayField?: string;
+    exactMatch?: boolean;
+    queryText?: string;
+}
+
+declare interface TableSearchHandlerParams<T> {
+    api: GridApi<T>;
+    filterModel?: FilterModel | null;
+    query?: string;
+}
+
+declare type TableSearchStyle = "query-builder" | "text";
+
 export { }