@rockrms/obsidian-framework 1.16.9-rc.1 → 17.0.43

package/types/Controls/Grid/grid.partial.obs.d.ts

@@ -1,718 +1,751 @@
-import { PropType } from "vue";
-import { GridAction, IGridState } from "@Obsidian/Types/Controls/grid";
-import { GridDataBag } from "@Obsidian/ViewModels/Core/Grid/gridDataBag";
-import { GridDefinitionBag } from "@Obsidian/ViewModels/Core/Grid/gridDefinitionBag";
-declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<{
-    /**
-     * The data to be displayed in the grid. This may either be an object
-     * that contains the grid data directly or a function that returns the
-     * grid data. The function may return a Promise which will be waited
-     * asynchronously until the data is ready.
-     */
-    data: {
-        type: PropType<GridDataBag | Promise<GridDataBag>>;
-    };
-    /**
-     * Contains the definition data about the grid. This contains information
-     * about the fields, action URLS and other features of the grid.
-     */
-    definition: {
-        type: PropType<GridDefinitionBag>;
-        required: false;
-    };
-    /**
-     * The title of the grid. If not provided and `isTitleHidden` is `false`,
-     * the default title of `${itemTerm} List` will be shown.
-     */
-    title: {
-        type: PropType<string>;
-        required: false;
-    };
-    /** When `true`, the grid's title will be hidden. */
-    isTitleHidden: {
-        type: PropType<boolean>;
-        default: boolean;
-    };
-    /**
-     * Identifies the field that will be used to uniquely identify each
-     * row. This is not required but many advanced features of the grid
-     * require this to function.
-     */
-    keyField: {
-        type: PropType<string>;
-        required: false;
-    };
-    /**
-     * Identifies the field that will contain the person key. If the grid
-     * does not represent Person records then leave this unset.
-     */
-    personKeyField: {
-        type: PropType<string>;
-        required: false;
-    };
-    /**
-     * Specifies the fields to be used to identify communication recipients
-     * when using the communicate action. This will take precedence over
-     * the personKeyField if both are set.
-     */
-    communicationRecipientPersonKeyFields: {
-        type: PropType<string[]>;
-        required: false;
-    };
-    /**
-     * Identifies the key that will be used to provide the tooltip text
-     * for each row in the Grid. This property is not reactive.
-     */
-    tooltipField: {
-        type: PropType<string>;
-        required: false;
-    };
-    /**
-     * Indicates that this grid should operate in light mode which disables
-     * a number of features. This is intended to be used with small grids
-     * that are embedded inside other blocks or controls.
-     */
-    light: {
-        type: PropType<boolean>;
-        default: boolean;
-    };
-    /**
-     * Determines if the grid will monitor for changes in the data of
-     * existing rows, new rows and removed rows. Should not be used for
-     * grids with more than 10,000 rows. This property is not reactive.
-     */
-    liveUpdates: {
-        type: PropType<boolean>;
-        required: false;
-    };
-    /** If enabled then the grid will have a sticky header. */
-    stickyHeader: {
-        type: PropType<boolean>;
-        default: boolean;
-    };
-    /**
-     * The term that identifies individual rows in the grid. This
-     * property is not reactive. If not specified it will default to "item".
-     * This value should be singular and not plural.
-     */
-    itemTerm: {
-        type: PropType<string>;
-        required: false;
-    };
-    /**
-     * The unique identifier of the entity type that the rows represent.
-     */
-    entityTypeGuid: {
-        type: PropType<string | undefined>;
-        required: false;
-    };
-    /**
-     * The title to use when exporting the grid contents. This is used as
-     * the exported filename as well as some other information inside the
-     * export file. If not specified it will default to the itemTerm
-     * property.
-     */
-    exportTitle: {
-        type: PropType<string>;
-        required: false;
-    };
-    /**
-     * If `true`, then any Person operations will instead be Business
-     * operations.
-     */
-    personAsBusiness: {
-        type: PropType<boolean>;
-        default: boolean;
-    };
-    /**
-     * If `true`, then the merge template operation will operate as if
-     * the records are Person records. If they are not then it will not
-     * work correctly. This required that personKeyField also be set.
-     */
-    mergeTemplateAsPerson: {
-        type: PropType<boolean>;
-        default: boolean;
-    };
-    /**
-     * Determines if the bulk update action will be available. If not
-     * explicitly set then it will default to enabled if the personKeyField
-     * property has been set.
-     */
-    showBulkUpdate: {
-        type: PropType<boolean | undefined>;
-        default: undefined;
-    };
-    /**
-     * Determines if the merge person/business action will be available. If not
-     * explicitly set then it will default to enabled if the personKeyField
-     * property has been set.
-     */
-    showPersonMerge: {
-        type: PropType<boolean | undefined>;
-        default: undefined;
-    };
-    /**
-     * Determines if the launch workflow action will be available. If not
-     * explicitly set then it will default to enabled if the entityTypeGuid
-     * and keyField properties have been set.
-     */
-    showLaunchWorkflow: {
-        type: PropType<boolean | undefined>;
-        default: undefined;
-    };
-    /**
-     * Determines if the communicate action will be available. If not
-     * explicitly set then it will default to enabled if either the
-     * personKeyField or communicationRecipientPersonKeyFields properties
-     * have been set.
-     */
-    showCommunicate: {
-        type: PropType<boolean | undefined>;
-        default: undefined;
-    };
-    /**
-     * Determines if the merge template action will be available. If not
-     * explicitly set then it will default to being shown. In the future
-     * this default state might change.
-     */
-    showMergeTemplate: {
-        type: PropType<boolean | undefined>;
-        default: undefined;
-    };
-    /**
-     * Determines if the export action will be available. If not explicitly
-     * set then it will default to being shown. In the future this default
-     * state might change.
-     */
-    showExport: {
-        type: PropType<boolean | undefined>;
-        default: undefined;
-    };
-    /**
-     * If set to true, each row with an `isActive` property set to false
-     * will be visually distinct
-     */
-    markInactiveRows: {
-        type: BooleanConstructor;
-        default: boolean;
-    };
-    /**
-     * A CSS class that will be applied to each row. If you supply a string,
-     * will apply that directly. You can also use a function that takes the
-     * row object and returns a string, which allows you to apply different
-     * classes to different rows depending on the row data.
-     */
-    rowClass: {
-        type: PropType<string | ((row: Record<string, unknown>) => string)>;
-        default: undefined;
-    };
-    /**
-     * The text to display in the empty data row. The default is an empty string (""), which indicates that this property is not set.
-     */
-    emptyDataText: {
-        type: StringConstructor;
-        default: string;
-        required: false;
-    };
-    /**
-     * Any fields that should be included when sending a communication. If
-     * a column name matches the field name then the formatted value of
-     * the column will be used. Otherwise the raw field value will be used.
-     */
-    communicationMergeFields: {
-        type: PropType<string[]>;
-        required: false;
-    };
-    /**
-     * The number of rows expected to fill the table. This does not
-     * need to be anywhere close to the real number. It is used to
-     * determine optimization settings and calculate how many skeleton
-     * rows to display while loading.
-     */
-    expectedRowCount: {
-        type: PropType<number>;
-        required: false;
-    };
-    /**
-     * Any custom actions that should be available for the individual to
-     * see in the list of actions.
-     */
-    customActions: {
-        type: PropType<GridAction[]>;
-        required: false;
-    };
-    /**
-     * The custom prefix to use when accessing person preferences related
-     * to the grid. This prefix is appended to the standard prefix used
-     * by the grid. This property is not reactive.
-     */
-    preferencePrefix: {
-        type: PropType<string>;
-        required: false;
-    };
-    /**
-     * When `true`, all preferences will be disabled on the grid. Preferences
-     * will not be read nor will they be saved. This property is not reactive.
-     */
-    disablePreferences: {
-        type: PropType<boolean>;
-        default: boolean;
-    };
-    /**
-     * When `true`, a grid settings icon will be displayed and emit the
-     * `gridSettingsClick` event when clicked.
-     */
-    gridSettings: {
-        type: PropType<boolean>;
-        default: boolean;
-    };
-    /**
-     * When `true`, the grid settings icon will be displayed in an active
-     * state. When `false`, the grid settings icon will be displayed in an
-     * in-active state.
-     */
-    gridSettingsActive: {
-        type: PropType<boolean>;
-        default: boolean;
-    };
-    /**
-     * The function to call in response to the add button being clicked.
-     * Providing this function will automatically enable the add button.
-     */
-    onAddItem: {
-        type: PropType<() => void | Promise<void>>;
-        required: false;
-    };
-    /**
-     * The function to call in response to a row being clicked. This
-     * requires that an keyField be specified. Providing this function will
-     * automatically enable row selection.
-     */
-    onSelectItem: {
-        type: PropType<(key: string) => void | Promise<void>>;
-        required: false;
-    };
-    /**
-     * When `true`, the row count message will be displayed. When `false`,
-     * the row count message will be hidden.
-     */
-    isCountMessageVisible: {
-        type: PropType<boolean>;
-        default: boolean;
-    };
-    /**
-     * When `true`, the search box will be displayed. When `false`, the
-     * search box will be hidden.
-     */
-    isSearchVisible: {
-        type: BooleanConstructor;
-        default: boolean;
-    };
-    /**
-     * Light mode: When `true`, the actions row will be hidden.
-     *
-
-     * Full mode: When `true`, paging will be disabled, making all data rows
-     * visible. Both the pager and actions rows will be hidden. If instead,
-     * you only want to disable paging, but still want the actions row to be
-     * shown, leave this property set to `false`, and set the `disablePaging`
-     * property to `true`.
-     */
-    isFooterHidden: {
-        type: PropType<boolean>;
-        default: boolean;
-    };
-    /**
-     * Light mode: This property will have no effect.
-     *
-     * Full mode: When `true`, paging will be disabled, making all data rows
-     * visible. The pager row will be hidden but the actions row will be
-     * shown. If instead, you want to hide BOTH the pager and actions rows,
-     * leave this property set to `false`, and set the `isFooterHidden`
-     * property to `true`.
-     */
-    disablePaging: {
-        type: PropType<boolean>;
-        default: boolean;
-    };
-}, {
-    deleteRow: (keyOrIndex: string | number) => void;
-    rowUpdated: (keyOrIndex: string | number) => void;
-    rowsUpdated: (keysOrIndexes: readonly string[] | readonly number[]) => void;
-}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
-    gridSettingsClick: () => void;
-} & {
-    filteredRowsChanged: (grid: IGridState) => void;
-} & {
-    selectedKeysChanged: (grid: IGridState) => void;
-}, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{
-    /**
-     * The data to be displayed in the grid. This may either be an object
-     * that contains the grid data directly or a function that returns the
-     * grid data. The function may return a Promise which will be waited
-     * asynchronously until the data is ready.
-     */
-    data: {
-        type: PropType<GridDataBag | Promise<GridDataBag>>;
-    };
-    /**
-     * Contains the definition data about the grid. This contains information
-     * about the fields, action URLS and other features of the grid.
-     */
-    definition: {
-        type: PropType<GridDefinitionBag>;
-        required: false;
-    };
-    /**
-     * The title of the grid. If not provided and `isTitleHidden` is `false`,
-     * the default title of `${itemTerm} List` will be shown.
-     */
-    title: {
-        type: PropType<string>;
-        required: false;
-    };
-    /** When `true`, the grid's title will be hidden. */
-    isTitleHidden: {
-        type: PropType<boolean>;
-        default: boolean;
-    };
-    /**
-     * Identifies the field that will be used to uniquely identify each
-     * row. This is not required but many advanced features of the grid
-     * require this to function.
-     */
-    keyField: {
-        type: PropType<string>;
-        required: false;
-    };
-    /**
-     * Identifies the field that will contain the person key. If the grid
-     * does not represent Person records then leave this unset.
-     */
-    personKeyField: {
-        type: PropType<string>;
-        required: false;
-    };
-    /**
-     * Specifies the fields to be used to identify communication recipients
-     * when using the communicate action. This will take precedence over
-     * the personKeyField if both are set.
-     */
-    communicationRecipientPersonKeyFields: {
-        type: PropType<string[]>;
-        required: false;
-    };
-    /**
-     * Identifies the key that will be used to provide the tooltip text
-     * for each row in the Grid. This property is not reactive.
-     */
-    tooltipField: {
-        type: PropType<string>;
-        required: false;
-    };
-    /**
-     * Indicates that this grid should operate in light mode which disables
-     * a number of features. This is intended to be used with small grids
-     * that are embedded inside other blocks or controls.
-     */
-    light: {
-        type: PropType<boolean>;
-        default: boolean;
-    };
-    /**
-     * Determines if the grid will monitor for changes in the data of
-     * existing rows, new rows and removed rows. Should not be used for
-     * grids with more than 10,000 rows. This property is not reactive.
-     */
-    liveUpdates: {
-        type: PropType<boolean>;
-        required: false;
-    };
-    /** If enabled then the grid will have a sticky header. */
-    stickyHeader: {
-        type: PropType<boolean>;
-        default: boolean;
-    };
-    /**
-     * The term that identifies individual rows in the grid. This
-     * property is not reactive. If not specified it will default to "item".
-     * This value should be singular and not plural.
-     */
-    itemTerm: {
-        type: PropType<string>;
-        required: false;
-    };
-    /**
-     * The unique identifier of the entity type that the rows represent.
-     */
-    entityTypeGuid: {
-        type: PropType<string | undefined>;
-        required: false;
-    };
-    /**
-     * The title to use when exporting the grid contents. This is used as
-     * the exported filename as well as some other information inside the
-     * export file. If not specified it will default to the itemTerm
-     * property.
-     */
-    exportTitle: {
-        type: PropType<string>;
-        required: false;
-    };
-    /**
-     * If `true`, then any Person operations will instead be Business
-     * operations.
-     */
-    personAsBusiness: {
-        type: PropType<boolean>;
-        default: boolean;
-    };
-    /**
-     * If `true`, then the merge template operation will operate as if
-     * the records are Person records. If they are not then it will not
-     * work correctly. This required that personKeyField also be set.
-     */
-    mergeTemplateAsPerson: {
-        type: PropType<boolean>;
-        default: boolean;
-    };
-    /**
-     * Determines if the bulk update action will be available. If not
-     * explicitly set then it will default to enabled if the personKeyField
-     * property has been set.
-     */
-    showBulkUpdate: {
-        type: PropType<boolean | undefined>;
-        default: undefined;
-    };
-    /**
-     * Determines if the merge person/business action will be available. If not
-     * explicitly set then it will default to enabled if the personKeyField
-     * property has been set.
-     */
-    showPersonMerge: {
-        type: PropType<boolean | undefined>;
-        default: undefined;
-    };
-    /**
-     * Determines if the launch workflow action will be available. If not
-     * explicitly set then it will default to enabled if the entityTypeGuid
-     * and keyField properties have been set.
-     */
-    showLaunchWorkflow: {
-        type: PropType<boolean | undefined>;
-        default: undefined;
-    };
-    /**
-     * Determines if the communicate action will be available. If not
-     * explicitly set then it will default to enabled if either the
-     * personKeyField or communicationRecipientPersonKeyFields properties
-     * have been set.
-     */
-    showCommunicate: {
-        type: PropType<boolean | undefined>;
-        default: undefined;
-    };
-    /**
-     * Determines if the merge template action will be available. If not
-     * explicitly set then it will default to being shown. In the future
-     * this default state might change.
-     */
-    showMergeTemplate: {
-        type: PropType<boolean | undefined>;
-        default: undefined;
-    };
-    /**
-     * Determines if the export action will be available. If not explicitly
-     * set then it will default to being shown. In the future this default
-     * state might change.
-     */
-    showExport: {
-        type: PropType<boolean | undefined>;
-        default: undefined;
-    };
-    /**
-     * If set to true, each row with an `isActive` property set to false
-     * will be visually distinct
-     */
-    markInactiveRows: {
-        type: BooleanConstructor;
-        default: boolean;
-    };
-    /**
-     * A CSS class that will be applied to each row. If you supply a string,
-     * will apply that directly. You can also use a function that takes the
-     * row object and returns a string, which allows you to apply different
-     * classes to different rows depending on the row data.
-     */
-    rowClass: {
-        type: PropType<string | ((row: Record<string, unknown>) => string)>;
-        default: undefined;
-    };
-    /**
-     * The text to display in the empty data row. The default is an empty string (""), which indicates that this property is not set.
-     */
-    emptyDataText: {
-        type: StringConstructor;
-        default: string;
-        required: false;
-    };
-    /**
-     * Any fields that should be included when sending a communication. If
-     * a column name matches the field name then the formatted value of
-     * the column will be used. Otherwise the raw field value will be used.
-     */
-    communicationMergeFields: {
-        type: PropType<string[]>;
-        required: false;
-    };
-    /**
-     * The number of rows expected to fill the table. This does not
-     * need to be anywhere close to the real number. It is used to
-     * determine optimization settings and calculate how many skeleton
-     * rows to display while loading.
-     */
-    expectedRowCount: {
-        type: PropType<number>;
-        required: false;
-    };
-    /**
-     * Any custom actions that should be available for the individual to
-     * see in the list of actions.
-     */
-    customActions: {
-        type: PropType<GridAction[]>;
-        required: false;
-    };
-    /**
-     * The custom prefix to use when accessing person preferences related
-     * to the grid. This prefix is appended to the standard prefix used
-     * by the grid. This property is not reactive.
-     */
-    preferencePrefix: {
-        type: PropType<string>;
-        required: false;
-    };
-    /**
-     * When `true`, all preferences will be disabled on the grid. Preferences
-     * will not be read nor will they be saved. This property is not reactive.
-     */
-    disablePreferences: {
-        type: PropType<boolean>;
-        default: boolean;
-    };
-    /**
-     * When `true`, a grid settings icon will be displayed and emit the
-     * `gridSettingsClick` event when clicked.
-     */
-    gridSettings: {
-        type: PropType<boolean>;
-        default: boolean;
-    };
-    /**
-     * When `true`, the grid settings icon will be displayed in an active
-     * state. When `false`, the grid settings icon will be displayed in an
-     * in-active state.
-     */
-    gridSettingsActive: {
-        type: PropType<boolean>;
-        default: boolean;
-    };
-    /**
-     * The function to call in response to the add button being clicked.
-     * Providing this function will automatically enable the add button.
-     */
-    onAddItem: {
-        type: PropType<() => void | Promise<void>>;
-        required: false;
-    };
-    /**
-     * The function to call in response to a row being clicked. This
-     * requires that an keyField be specified. Providing this function will
-     * automatically enable row selection.
-     */
-    onSelectItem: {
-        type: PropType<(key: string) => void | Promise<void>>;
-        required: false;
-    };
-    /**
-     * When `true`, the row count message will be displayed. When `false`,
-     * the row count message will be hidden.
-     */
-    isCountMessageVisible: {
-        type: PropType<boolean>;
-        default: boolean;
-    };
-    /**
-     * When `true`, the search box will be displayed. When `false`, the
-     * search box will be hidden.
-     */
-    isSearchVisible: {
-        type: BooleanConstructor;
-        default: boolean;
-    };
-    /**
-     * Light mode: When `true`, the actions row will be hidden.
-     *
-
-     * Full mode: When `true`, paging will be disabled, making all data rows
-     * visible. Both the pager and actions rows will be hidden. If instead,
-     * you only want to disable paging, but still want the actions row to be
-     * shown, leave this property set to `false`, and set the `disablePaging`
-     * property to `true`.
-     */
-    isFooterHidden: {
-        type: PropType<boolean>;
-        default: boolean;
-    };
-    /**
-     * Light mode: This property will have no effect.
-     *
-     * Full mode: When `true`, paging will be disabled, making all data rows
-     * visible. The pager row will be hidden but the actions row will be
-     * shown. If instead, you want to hide BOTH the pager and actions rows,
-     * leave this property set to `false`, and set the `isFooterHidden`
-     * property to `true`.
-     */
-    disablePaging: {
-        type: PropType<boolean>;
-        default: boolean;
-    };
-}>> & {
-    onFilteredRowsChanged?: ((grid: IGridState) => any) | undefined;
-    onSelectedKeysChanged?: ((grid: IGridState) => any) | undefined;
-    onGridSettingsClick?: (() => any) | undefined;
-}, {
-    light: boolean;
-    isFooterHidden: boolean;
-    markInactiveRows: boolean;
-    rowClass: string | ((row: Record<string, unknown>) => string);
-    emptyDataText: string;
-    isTitleHidden: boolean;
-    isCountMessageVisible: boolean;
-    isSearchVisible: boolean;
-    stickyHeader: boolean;
-    personAsBusiness: boolean;
-    mergeTemplateAsPerson: boolean;
-    showBulkUpdate: boolean | undefined;
-    showPersonMerge: boolean | undefined;
-    showLaunchWorkflow: boolean | undefined;
-    showCommunicate: boolean | undefined;
-    showMergeTemplate: boolean | undefined;
-    showExport: boolean | undefined;
-    disablePreferences: boolean;
-    gridSettings: boolean;
-    gridSettingsActive: boolean;
-    disablePaging: boolean;
-}>, {
-    gridHeaderPrepend: (_: {}) => any;
-    gridHeaderAppend: (_: {}) => any;
-    gridFooterPrepend: (_: {}) => any;
-    gridFooterAppend: (_: {}) => any;
-}>;
-export default _default;
-declare type __VLS_WithTemplateSlots<T, S> = T & {
-    new (): {
-        $slots: S;
-    };
-};
+import { PropType } from "vue";
+import { GridAction, IGridState } from "@Obsidian/Types/Controls/grid";
+import { GridDataBag } from "@Obsidian/ViewModels/Core/Grid/gridDataBag";
+import { GridDefinitionBag } from "@Obsidian/ViewModels/Core/Grid/gridDefinitionBag";
+/**
+ * Deletes a row from the grid when not tracking live updates.
+ *
+ * @param keyOrIndex The row key or row index that should be deleted.
+ */
+declare function deleteRow(keyOrIndex: string | number): void;
+/**
+ * Informs the grid that the specified row has been modified.
+ *
+ * @param keyOrIndex The row key or index that was updated.
+ */
+declare function rowUpdated(keyOrIndex: string | number): void;
+/**
+ * Informs the grid that the specified rows have been modified.
+ *
+ * @param keysOrIndexes The row keys or indexes that have been updated.
+ */
+declare function rowsUpdated(keysOrIndexes: readonly string[] | readonly number[]): void;
+declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<{
+    /**
+     * The data to be displayed in the grid. This may either be an object
+     * that contains the grid data directly or a function that returns the
+     * grid data. The function may return a Promise which will be waited
+     * asynchronously until the data is ready.
+     */
+    data: {
+        type: PropType<GridDataBag | Promise<GridDataBag>>;
+    };
+    /**
+     * Contains the definition data about the grid. This contains information
+     * about the fields, action URLS and other features of the grid.
+     */
+    definition: {
+        type: PropType<GridDefinitionBag>;
+        required: false;
+    };
+    /**
+     * The title of the grid. If not provided and `isTitleHidden` is `false`,
+     * the default title of `${itemTerm} List` will be shown.
+     */
+    title: {
+        type: PropType<string>;
+        required: false;
+    };
+    /** When `true`, the grid's title will be hidden. */
+    isTitleHidden: {
+        type: PropType<boolean>;
+        default: boolean;
+    };
+    /**
+     * Identifies the field that will be used to uniquely identify each
+     * row. This is not required but many advanced features of the grid
+     * require this to function.
+     */
+    keyField: {
+        type: PropType<string>;
+        required: false;
+    };
+    /**
+     * Identifies the field that will contain the person key. If the grid
+     * does not represent Person records then leave this unset.
+     */
+    personKeyField: {
+        type: PropType<string>;
+        required: false;
+    };
+    /**
+     * Specifies the fields to be used to identify communication recipients
+     * when using the communicate action. This will take precedence over
+     * the personKeyField if both are set.
+     */
+    communicationRecipientPersonKeyFields: {
+        type: PropType<string[]>;
+        required: false;
+    };
+    /**
+     * Identifies the key that will be used to provide the tooltip text
+     * for each row in the Grid. This property is not reactive.
+     */
+    tooltipField: {
+        type: PropType<string>;
+        required: false;
+    };
+    /**
+     * Indicates that this grid should operate in light mode which disables
+     * a number of features. This is intended to be used with small grids
+     * that are embedded inside other blocks or controls.
+     */
+    light: {
+        type: PropType<boolean>;
+        default: boolean;
+    };
+    /**
+     * Determines if the grid will monitor for changes in the data of
+     * existing rows, new rows and removed rows. Should not be used for
+     * grids with more than 10,000 rows. This property is not reactive.
+     */
+    liveUpdates: {
+        type: PropType<boolean>;
+        required: false;
+    };
+    /**
+     * If true, the filter header row containing the row counts,
+     * quick filters and other grid data will be hidden. Defaults to false.
+     * */
+    hideFilterHeaderRow: {
+        type: PropType<boolean>;
+        default: boolean;
+    };
+    /** If enabled then the grid will have a sticky header. */
+    stickyHeader: {
+        type: PropType<boolean>;
+        default: boolean;
+    };
+    /**
+     * The term that identifies individual rows in the grid. This
+     * property is not reactive. If not specified it will default to "item".
+     * This value should be singular and not plural.
+     */
+    itemTerm: {
+        type: PropType<string>;
+        required: false;
+    };
+    /**
+     * The unique identifier of the entity type that the rows represent.
+     */
+    entityTypeGuid: {
+        type: PropType<string | undefined>;
+        required: false;
+    };
+    /**
+     * The title to use when exporting the grid contents. This is used as
+     * the exported filename as well as some other information inside the
+     * export file. If not specified it will default to the itemTerm
+     * property.
+     */
+    exportTitle: {
+        type: PropType<string>;
+        required: false;
+    };
+    /**
+     * If `true`, then any Person operations will instead be Business
+     * operations.
+     */
+    personAsBusiness: {
+        type: PropType<boolean>;
+        default: boolean;
+    };
+    /**
+     * If `true`, then the merge template operation will operate as if
+     * the records are Person records. If they are not then it will not
+     * work correctly. This required that personKeyField also be set.
+     */
+    mergeTemplateAsPerson: {
+        type: PropType<boolean>;
+        default: boolean;
+    };
+    /**
+     * Determines if the bulk update action will be available. If not
+     * explicitly set then it will default to enabled if the personKeyField
+     * property has been set.
+     */
+    showBulkUpdate: {
+        type: PropType<boolean | undefined>;
+        default: undefined;
+    };
+    /**
+     * Determines if the merge person/business action will be available. If not
+     * explicitly set then it will default to enabled if the personKeyField
+     * property has been set.
+     */
+    showPersonMerge: {
+        type: PropType<boolean | undefined>;
+        default: undefined;
+    };
+    /**
+     * Determines if the launch workflow action will be available. If not
+     * explicitly set then it will default to enabled if the entityTypeGuid
+     * and keyField properties have been set.
+     */
+    showLaunchWorkflow: {
+        type: PropType<boolean | undefined>;
+        default: undefined;
+    };
+    /**
+     * Determines if the communicate action will be available. If not
+     * explicitly set then it will default to enabled if either the
+     * personKeyField or communicationRecipientPersonKeyFields properties
+     * have been set.
+     */
+    showCommunicate: {
+        type: PropType<boolean | undefined>;
+        default: undefined;
+    };
+    /**
+     * Determines if the merge template action will be available. If not
+     * explicitly set then it will default to being shown. In the future
+     * this default state might change.
+     */
+    showMergeTemplate: {
+        type: PropType<boolean | undefined>;
+        default: undefined;
+    };
+    /**
+     * Determines if the export action will be available. If not explicitly
+     * set then it will default to being shown. In the future this default
+     * state might change.
+     */
+    showExport: {
+        type: PropType<boolean | undefined>;
+        default: undefined;
+    };
+    /**
+     * If set to true, each row with an `isActive` property set to false
+     * will be visually distinct
+     */
+    markInactiveRows: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * A CSS class that will be applied to each row. If you supply a string,
+     * will apply that directly. You can also use a function that takes the
+     * row object and returns a string, which allows you to apply different
+     * classes to different rows depending on the row data.
+     */
+    rowClass: {
+        type: PropType<string | ((row: Record<string, unknown>) => string)>;
+        default: undefined;
+    };
+    /**
+     * The text to display in the empty data row. The default is an empty string (""), which indicates that this property is not set.
+     */
+    emptyDataText: {
+        type: StringConstructor;
+        default: string;
+        required: false;
+    };
+    /**
+     * Any fields that should be included when sending a communication. If
+     * a column name matches the field name then the formatted value of
+     * the column will be used. Otherwise the raw field value will be used.
+     */
+    communicationMergeFields: {
+        type: PropType<string[]>;
+        required: false;
+    };
+    /**
+     * The number of rows expected to fill the table. This does not
+     * need to be anywhere close to the real number. It is used to
+     * determine optimization settings and calculate how many skeleton
+     * rows to display while loading.
+     */
+    expectedRowCount: {
+        type: PropType<number>;
+        required: false;
+    };
+    /**
+     * Any custom actions that should be available for the individual to
+     * see in the list of actions.
+     */
+    customActions: {
+        type: PropType<GridAction[]>;
+        required: false;
+    };
+    /**
+     * The custom prefix to use when accessing person preferences related
+     * to the grid. This prefix is appended to the standard prefix used
+     * by the grid. This property is not reactive.
+     */
+    preferencePrefix: {
+        type: PropType<string>;
+        required: false;
+    };
+    /**
+     * When `true`, all preferences will be disabled on the grid. Preferences
+     * will not be read nor will they be saved. This property is not reactive.
+     */
+    disablePreferences: {
+        type: PropType<boolean>;
+        default: boolean;
+    };
+    /**
+     * When `true`, a grid settings icon will be displayed and emit the
+     * `gridSettingsClick` event when clicked.
+     */
+    gridSettings: {
+        type: PropType<boolean>;
+        default: boolean;
+    };
+    /**
+     * When `true`, the grid settings icon will be displayed in an active
+     * state. When `false`, the grid settings icon will be displayed in an
+     * in-active state.
+     */
+    gridSettingsActive: {
+        type: PropType<boolean>;
+        default: boolean;
+    };
+    /**
+     * The function to call in response to the add button being clicked.
+     * Providing this function will automatically enable the add button.
+     */
+    onAddItem: {
+        type: PropType<() => void | Promise<void>>;
+        required: false;
+    };
+    /**
+     * The function to call in response to a row being clicked. This
+     * requires that an keyField be specified. Providing this function will
+     * automatically enable row selection.
+     */
+    onSelectItem: {
+        type: PropType<(key: string) => void | Promise<void>>;
+        required: false;
+    };
+    /**
+     * When `true`, the row count message will be displayed. When `false`,
+     * the row count message will be hidden.
+     */
+    isCountMessageVisible: {
+        type: PropType<boolean>;
+        default: boolean;
+    };
+    /**
+     * When `true`, the search box will be displayed. When `false`, the
+     * search box will be hidden.
+     */
+    isSearchVisible: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * Light mode: When `true`, the actions row will be hidden.
+     *
+
+     * Full mode: When `true`, paging will be disabled, making all data rows
+     * visible. Both the pager and actions rows will be hidden. If instead,
+     * you only want to disable paging, but still want the actions row to be
+     * shown, leave this property set to `false`, and set the `disablePaging`
+     * property to `true`.
+     */
+    isFooterHidden: {
+        type: PropType<boolean>;
+        default: boolean;
+    };
+    /**
+     * Light mode: This property will have no effect.
+     *
+     * Full mode: When `true`, paging will be disabled, making all data rows
+     * visible. The pager row will be hidden but the actions row will be
+     * shown. If instead, you want to hide BOTH the pager and actions rows,
+     * leave this property set to `false`, and set the `isFooterHidden`
+     * property to `true`.
+     */
+    disablePaging: {
+        type: PropType<boolean>;
+        default: boolean;
+    };
+}, {
+    deleteRow: typeof deleteRow;
+    rowUpdated: typeof rowUpdated;
+    rowsUpdated: typeof rowsUpdated;
+}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
+    gridSettingsClick: () => void;
+    filteredRowsChanged: (grid: IGridState) => void;
+    selectedKeysChanged: (grid: IGridState) => void;
+}, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{
+    /**
+     * The data to be displayed in the grid. This may either be an object
+     * that contains the grid data directly or a function that returns the
+     * grid data. The function may return a Promise which will be waited
+     * asynchronously until the data is ready.
+     */
+    data: {
+        type: PropType<GridDataBag | Promise<GridDataBag>>;
+    };
+    /**
+     * Contains the definition data about the grid. This contains information
+     * about the fields, action URLS and other features of the grid.
+     */
+    definition: {
+        type: PropType<GridDefinitionBag>;
+        required: false;
+    };
+    /**
+     * The title of the grid. If not provided and `isTitleHidden` is `false`,
+     * the default title of `${itemTerm} List` will be shown.
+     */
+    title: {
+        type: PropType<string>;
+        required: false;
+    };
+    /** When `true`, the grid's title will be hidden. */
+    isTitleHidden: {
+        type: PropType<boolean>;
+        default: boolean;
+    };
+    /**
+     * Identifies the field that will be used to uniquely identify each
+     * row. This is not required but many advanced features of the grid
+     * require this to function.
+     */
+    keyField: {
+        type: PropType<string>;
+        required: false;
+    };
+    /**
+     * Identifies the field that will contain the person key. If the grid
+     * does not represent Person records then leave this unset.
+     */
+    personKeyField: {
+        type: PropType<string>;
+        required: false;
+    };
+    /**
+     * Specifies the fields to be used to identify communication recipients
+     * when using the communicate action. This will take precedence over
+     * the personKeyField if both are set.
+     */
+    communicationRecipientPersonKeyFields: {
+        type: PropType<string[]>;
+        required: false;
+    };
+    /**
+     * Identifies the key that will be used to provide the tooltip text
+     * for each row in the Grid. This property is not reactive.
+     */
+    tooltipField: {
+        type: PropType<string>;
+        required: false;
+    };
+    /**
+     * Indicates that this grid should operate in light mode which disables
+     * a number of features. This is intended to be used with small grids
+     * that are embedded inside other blocks or controls.
+     */
+    light: {
+        type: PropType<boolean>;
+        default: boolean;
+    };
+    /**
+     * Determines if the grid will monitor for changes in the data of
+     * existing rows, new rows and removed rows. Should not be used for
+     * grids with more than 10,000 rows. This property is not reactive.
+     */
+    liveUpdates: {
+        type: PropType<boolean>;
+        required: false;
+    };
+    /**
+     * If true, the filter header row containing the row counts,
+     * quick filters and other grid data will be hidden. Defaults to false.
+     * */
+    hideFilterHeaderRow: {
+        type: PropType<boolean>;
+        default: boolean;
+    };
+    /** If enabled then the grid will have a sticky header. */
+    stickyHeader: {
+        type: PropType<boolean>;
+        default: boolean;
+    };
+    /**
+     * The term that identifies individual rows in the grid. This
+     * property is not reactive. If not specified it will default to "item".
+     * This value should be singular and not plural.
+     */
+    itemTerm: {
+        type: PropType<string>;
+        required: false;
+    };
+    /**
+     * The unique identifier of the entity type that the rows represent.
+     */
+    entityTypeGuid: {
+        type: PropType<string | undefined>;
+        required: false;
+    };
+    /**
+     * The title to use when exporting the grid contents. This is used as
+     * the exported filename as well as some other information inside the
+     * export file. If not specified it will default to the itemTerm
+     * property.
+     */
+    exportTitle: {
+        type: PropType<string>;
+        required: false;
+    };
+    /**
+     * If `true`, then any Person operations will instead be Business
+     * operations.
+     */
+    personAsBusiness: {
+        type: PropType<boolean>;
+        default: boolean;
+    };
+    /**
+     * If `true`, then the merge template operation will operate as if
+     * the records are Person records. If they are not then it will not
+     * work correctly. This required that personKeyField also be set.
+     */
+    mergeTemplateAsPerson: {
+        type: PropType<boolean>;
+        default: boolean;
+    };
+    /**
+     * Determines if the bulk update action will be available. If not
+     * explicitly set then it will default to enabled if the personKeyField
+     * property has been set.
+     */
+    showBulkUpdate: {
+        type: PropType<boolean | undefined>;
+        default: undefined;
+    };
+    /**
+     * Determines if the merge person/business action will be available. If not
+     * explicitly set then it will default to enabled if the personKeyField
+     * property has been set.
+     */
+    showPersonMerge: {
+        type: PropType<boolean | undefined>;
+        default: undefined;
+    };
+    /**
+     * Determines if the launch workflow action will be available. If not
+     * explicitly set then it will default to enabled if the entityTypeGuid
+     * and keyField properties have been set.
+     */
+    showLaunchWorkflow: {
+        type: PropType<boolean | undefined>;
+        default: undefined;
+    };
+    /**
+     * Determines if the communicate action will be available. If not
+     * explicitly set then it will default to enabled if either the
+     * personKeyField or communicationRecipientPersonKeyFields properties
+     * have been set.
+     */
+    showCommunicate: {
+        type: PropType<boolean | undefined>;
+        default: undefined;
+    };
+    /**
+     * Determines if the merge template action will be available. If not
+     * explicitly set then it will default to being shown. In the future
+     * this default state might change.
+     */
+    showMergeTemplate: {
+        type: PropType<boolean | undefined>;
+        default: undefined;
+    };
+    /**
+     * Determines if the export action will be available. If not explicitly
+     * set then it will default to being shown. In the future this default
+     * state might change.
+     */
+    showExport: {
+        type: PropType<boolean | undefined>;
+        default: undefined;
+    };
+    /**
+     * If set to true, each row with an `isActive` property set to false
+     * will be visually distinct
+     */
+    markInactiveRows: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * A CSS class that will be applied to each row. If you supply a string,
+     * will apply that directly. You can also use a function that takes the
+     * row object and returns a string, which allows you to apply different
+     * classes to different rows depending on the row data.
+     */
+    rowClass: {
+        type: PropType<string | ((row: Record<string, unknown>) => string)>;
+        default: undefined;
+    };
+    /**
+     * The text to display in the empty data row. The default is an empty string (""), which indicates that this property is not set.
+     */
+    emptyDataText: {
+        type: StringConstructor;
+        default: string;
+        required: false;
+    };
+    /**
+     * Any fields that should be included when sending a communication. If
+     * a column name matches the field name then the formatted value of
+     * the column will be used. Otherwise the raw field value will be used.
+     */
+    communicationMergeFields: {
+        type: PropType<string[]>;
+        required: false;
+    };
+    /**
+     * The number of rows expected to fill the table. This does not
+     * need to be anywhere close to the real number. It is used to
+     * determine optimization settings and calculate how many skeleton
+     * rows to display while loading.
+     */
+    expectedRowCount: {
+        type: PropType<number>;
+        required: false;
+    };
+    /**
+     * Any custom actions that should be available for the individual to
+     * see in the list of actions.
+     */
+    customActions: {
+        type: PropType<GridAction[]>;
+        required: false;
+    };
+    /**
+     * The custom prefix to use when accessing person preferences related
+     * to the grid. This prefix is appended to the standard prefix used
+     * by the grid. This property is not reactive.
+     */
+    preferencePrefix: {
+        type: PropType<string>;
+        required: false;
+    };
+    /**
+     * When `true`, all preferences will be disabled on the grid. Preferences
+     * will not be read nor will they be saved. This property is not reactive.
+     */
+    disablePreferences: {
+        type: PropType<boolean>;
+        default: boolean;
+    };
+    /**
+     * When `true`, a grid settings icon will be displayed and emit the
+     * `gridSettingsClick` event when clicked.
+     */
+    gridSettings: {
+        type: PropType<boolean>;
+        default: boolean;
+    };
+    /**
+     * When `true`, the grid settings icon will be displayed in an active
+     * state. When `false`, the grid settings icon will be displayed in an
+     * in-active state.
+     */
+    gridSettingsActive: {
+        type: PropType<boolean>;
+        default: boolean;
+    };
+    /**
+     * The function to call in response to the add button being clicked.
+     * Providing this function will automatically enable the add button.
+     */
+    onAddItem: {
+        type: PropType<() => void | Promise<void>>;
+        required: false;
+    };
+    /**
+     * The function to call in response to a row being clicked. This
+     * requires that an keyField be specified. Providing this function will
+     * automatically enable row selection.
+     */
+    onSelectItem: {
+        type: PropType<(key: string) => void | Promise<void>>;
+        required: false;
+    };
+    /**
+     * When `true`, the row count message will be displayed. When `false`,
+     * the row count message will be hidden.
+     */
+    isCountMessageVisible: {
+        type: PropType<boolean>;
+        default: boolean;
+    };
+    /**
+     * When `true`, the search box will be displayed. When `false`, the
+     * search box will be hidden.
+     */
+    isSearchVisible: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * Light mode: When `true`, the actions row will be hidden.
+     *
+
+     * Full mode: When `true`, paging will be disabled, making all data rows
+     * visible. Both the pager and actions rows will be hidden. If instead,
+     * you only want to disable paging, but still want the actions row to be
+     * shown, leave this property set to `false`, and set the `disablePaging`
+     * property to `true`.
+     */
+    isFooterHidden: {
+        type: PropType<boolean>;
+        default: boolean;
+    };
+    /**
+     * Light mode: This property will have no effect.
+     *
+     * Full mode: When `true`, paging will be disabled, making all data rows
+     * visible. The pager row will be hidden but the actions row will be
+     * shown. If instead, you want to hide BOTH the pager and actions rows,
+     * leave this property set to `false`, and set the `isFooterHidden`
+     * property to `true`.
+     */
+    disablePaging: {
+        type: PropType<boolean>;
+        default: boolean;
+    };
+}>> & {
+    onFilteredRowsChanged?: ((grid: IGridState) => any) | undefined;
+    onSelectedKeysChanged?: ((grid: IGridState) => any) | undefined;
+    onGridSettingsClick?: (() => any) | undefined;
+}, {
+    light: boolean;
+    isFooterHidden: boolean;
+    markInactiveRows: boolean;
+    rowClass: string | ((row: Record<string, unknown>) => string);
+    emptyDataText: string;
+    isTitleHidden: boolean;
+    isCountMessageVisible: boolean;
+    isSearchVisible: boolean;
+    hideFilterHeaderRow: boolean;
+    stickyHeader: boolean;
+    personAsBusiness: boolean;
+    mergeTemplateAsPerson: boolean;
+    showBulkUpdate: boolean | undefined;
+    showPersonMerge: boolean | undefined;
+    showLaunchWorkflow: boolean | undefined;
+    showCommunicate: boolean | undefined;
+    showMergeTemplate: boolean | undefined;
+    showExport: boolean | undefined;
+    disablePreferences: boolean;
+    gridSettings: boolean;
+    gridSettingsActive: boolean;
+    disablePaging: boolean;
+}, {}>, {
+    gridHeaderPrepend?(_: {}): any;
+    gridHeaderAppend?(_: {}): any;
+    gridFooterPrepend?(_: {}): any;
+    gridFooterAppend?(_: {}): any;
+}>;
+export default _default;
+type __VLS_WithTemplateSlots<T, S> = T & {
+    new (): {
+        $slots: S;
+    };
+};