@skyux/ag-grid 13.0.0 → 13.0.1

package/index.d.ts

@@ -179,17 +179,60 @@ declare class SkyAgGridService implements OnDestroy {
 }
 
 interface SkyAgGridAutocompleteProperties {
+    /**
+     * Allows users to specify arbitrary values not in the search results.
+     * @default false
+     */
     allowAnyValue?: boolean;
+    /**
+     * The static data source for the autocomplete cell to search when users enter text. For a dynamic data source, such as an array that changes due to server calls, use search instead. You can specify static data, such as an array of objects, or you can pull data from a database.
+     */
     data?: unknown[];
+    /**
+     * How many milliseconds to wait before searching while users enter text in the autocomplete field.
+     * @default 0
+     */
     debounceTime?: number;
+    /**
+     * The object property to display in the text input after users select an item in the dropdown list.
+     * @default "name"
+     */
     descriptorProperty?: string;
+    /**
+     * Highlights the search text in each search result. Set this to `false` when your search returns results that aren't exact text matches, such as returning "Bob" for "Robert."
+     * @default true
+     */
     highlightSearchText?: boolean;
+    /**
+     * The array of object properties to search when utilizing the `data` property and the built-in search function.
+  
+     * @default ["name"]
+     */
     propertiesToSearch?: string[];
+    /**
+     * The function that dynamically manages the data to display in search results when users change the text in the autocomplete cell. The search function must return an array or a promise of an array.
+     */
     search?: (searchText: string, data?: unknown[]) => unknown[] | Promise<unknown[]>;
+    /**
+     * The array of functions to call against each search result. This filters the search results when using the `data` input and the default search function. When the `search` property specifies a custom search function, you must manually apply filters inside that function. The function must return `true` or `false` for each result to indicate whether to display it in the dropdown list.
+     */
     searchFilters?: ((searchText: string, item: unknown) => boolean)[];
+    /**
+     * The maximum number of search results to display in the dropdown list. By default, the autocomplete component displays all matching results.
+     */
     searchResultsLimit?: number;
+    /**
+     * The template that formats each search result in the dropdown list. The autocomplete component injects search result values into the template as `item` variables that reference all of the object properties of the search results.
+     */
     searchResultTemplate?: TemplateRef<unknown>;
+    /**
+     * The minimum number of characters that users must enter before the autocomplete component searches the data source and displays search results in the dropdown list.
+     * @default 1
+     */
     searchTextMinimumCharacters?: number;
+    /**
+     * Output that fires when users select items in the dropdown list.
+     */
     selectionChange?: (event: SkyAutocompleteSelectionChange) => void;
 }
 /**
@@ -218,15 +261,40 @@ declare enum SkyCellClass {
 }
 
 interface SkyCellEditorAutocompleteParams extends ICellEditorParams {
+    /**
+     * The parameters provided to the autocomplete component.
+     */
     skyComponentProperties?: SkyAutocompleteProperties | SkyAgGridAutocompleteProperties;
 }
 
 interface SkyAgGridDatepickerProperties {
+    /**
+     * The date format for the input.
+     * @default "MM/DD/YYYY"
+     */
     dateFormat?: string;
+    /**
+     * Whether to disable the datepicker cell.
+     * @default false
+     */
     disabled?: boolean;
+    /**
+     * The latest date that is available in the calendar.
+     */
     maxDate?: Date;
+    /**
+     * The earliest date that is available in the calendar. To avoid validation errors, the time associated with the minimum date is midnight. This is necessary because the datepicker automatically sets the time on the Date object for selected dates to midnight in the current user's time zone.
+     */
     minDate?: Date;
+    /**
+     * Whether to disable date validation on the datepicker input.
+     * @default false
+     */
     skyDatepickerNoValidate?: boolean;
+    /**
+     * The starting day of the week in the calendar. `0` sets the starting day to Sunday.
+     * @default 0
+     */
     startingDay?: number;
 }
 /**
@@ -236,6 +304,9 @@ interface SkyDatepickerProperties extends SkyAgGridDatepickerProperties {
 }
 
 interface SkyCellEditorDatepickerParams extends ICellEditorParams {
+    /**
+     * The parameters provided to the datepicker component.
+     */
     skyComponentProperties?: SkyDatepickerProperties | SkyAgGridDatepickerProperties;
 }
 
@@ -252,32 +323,114 @@ declare enum SkyAgGridCellEditorInitialAction {
 }
 
 interface SkyAgGridLookupProperties {
+    /**
+     * Fires when users select the button to add options to the list.
+     */
     addClick?: (args: SkyLookupAddClickEventArgs) => void;
+    /**
+     * The `aria-label` text for the lookup cell. If neither `ariaLabel` nor `ariaLabelledBy` are specified, the `aria-label` defaults to the column's `headerName`, `headerTooltip`, `field`, or `colId`.
+     */
     ariaLabel?: string;
+    /**
+     * The ID of the HTML element that labels the lookup cell. If neither `ariaLabel` nor `ariaLabelledBy` are specified, the `aria-label` defaults to the column's `headerName`, `headerTooltip`, `field`, or `colId`.
+     */
     ariaLabelledBy?: string;
-    /** @deprecated */
+    /**
+     * The value to provide to the autocomplete attribute on the form input.
+     * @default "off"
+     * @deprecated
+     */
     autocompleteAttribute?: string;
+    /**
+     * The data source for the lookup cell to search when users enter text. You can specify static data, such as an array of objects, or you can pull data from a database.
+     * @deprecated Use the `searchAsync` event emitter and callback instead to provide data to the lookup component.
+     */
     data?: unknown[];
+    /**
+     * How many milliseconds to wait before searching while users enter text in the lookup field.
+     * @default 0
+     */
     debounceTime?: number;
+    /**
+     * The object property to display in the text input after users select an item in the dropdown list.
+     * @default "name"
+     */
     descriptorProperty?: string;
+    /**
+     * Whether to disable the lookup cell.
+     * @default false
+     */
     disabled?: boolean;
+    /**
+     * Whether to enable users to open a picker where they can view all options.
+     * @default false
+     */
     enableShowMore?: boolean;
+    /**
+     * The property that represents the object's unique identifier. Specifying this property enables token animations and more efficient rendering. This property is required when using `enableShowMore` and `searchAsync` together.
+     */
     idProperty?: string;
+    /**
+     * Placeholder text to display in the lookup field.
+     */
     placeholderText?: string;
+    /**
+     * The array of object properties to search when using the `data` property and the built-in search function.
+     * @default ["name"]
+     * @deprecated Use the `searchAsync` event emitter and callback instead to provide data to the lookup component.
+     */
     propertiesToSearch?: string[];
+    /**
+     * The function that dynamically manages the data to display in search results when users change the text in the lookup cell. The search function must return an array or a promise of an array.
+     * @deprecated Use the `searchAsync` event emitter and callback instead to provide searched data to the lookup component.
+     */
     search?: SkyAutocompleteSearchFunction;
+    /**
+     * Fires when users enter new search information and allows results to be returned via an observable. The event is also fired when the "Show more" picker is opened without search text.
+     */
     searchAsync?: (args: SkyAutocompleteSearchAsyncArgs) => void;
+    /**
+     * The array of functions to call against each search result. This filters the search results when using the `data` input and the default search function. When the `search` property specifies a custom search function, you must manually apply filters inside that function. The function must return `true` or `false` for each result to indicate whether to display it in the dropdown list.
+     * @deprecated  Use the `searchAsync` event emitter and callback instead to provide searched data to the lookup component.
+     */
     searchFilters?: SkyAutocompleteSearchFunctionFilter[];
+    /**
+     * The maximum number of search results to display in the dropdown list. By default, the lookup component displays all matching results. This property has no effect on the results in the "Show more" picker.
+     */
     searchResultsLimit?: number;
+    /**
+     * The template that formats each option in the dropdown list. The lookup component injects values into the template as `item` variables that reference all of the object properties of the search results.
+     */
     searchResultTemplate?: TemplateRef<unknown>;
+    /**
+     * The minimum number of characters that users must enter before the lookup component searches the data source and displays search results in the dropdown list.
+     * @default 1
+     */
     searchTextMinimumCharacters?: number;
+    /**
+     * The ability for users to select one option or multiple options.
+     * @default "multiple"
+     */
     selectMode?: SkyLookupSelectModeType;
+    /**
+     * Whether to display a button that lets users add options to the list.
+     * @default false
+     */
     showAddButton?: boolean;
+    /**
+     * Configuration options for the picker that displays all options.
+     */
     showMoreConfig?: SkyLookupShowMoreConfig;
+    /**
+     * @internal
+     */
     wrapperClass?: string;
 }
 
 interface SkyCellEditorLookupParams extends ICellEditorParams {
+    /**
+     * The parameters provided to the lookup component.
+     */
     skyComponentProperties?: SkyAgGridLookupProperties;
 }
 
@@ -287,6 +440,11 @@ declare class SkyAgGridCellEditorUtils {
      * @param params The editor's initializing parameters.
      */
     static getEditorInitialAction(params: ICellEditorParams | undefined): SkyAgGridCellEditorInitialAction;
+    /**
+     * Returns the difference between the minuend and subtrahend. If the minuend is not defined, returns 0.
+     * @param minuend The number from which another number is subtracted.
+     * @param subtrahend The number that is subtracted from the minuend.
+     */
     static subtractOrZero(minuend: number | null | undefined, subtrahend: number): number;
 }
 
@@ -394,8 +552,19 @@ declare enum SkyCellType {
 }
 
 interface SkyAgGridCurrencyProperties {
+    /**
+     * The currency symbol to display in the cell.
+     * @default "$"
+     */
     currencySymbol?: string;
+    /**
+     * The number of decimal places to display on the currency.
+     * @default 2
+     */
     decimalPlaces?: number | string;
+    /**
+     * Adds the specified brackets around negative values when unfocused.
+     */
     negativeBracketsTypeOnBlur?: '(,)' | '[,]' | '<,>' | '{,}' | '〈,〉' | '｢,｣' | '⸤,⸥' | '⟦,⟧' | '‹,›' | '«,»' | null;
 }
 
@@ -492,11 +661,20 @@ interface SkyAgGridHeaderParams extends IHeaderParams {
 }
 
 interface SkyAgGridNumberProperties {
+    /**
+     * The maximum number that users can enter in the cell.
+     */
     max?: number;
+    /**
+     * The minimum number that users can enter in the cell.
+     */
     min?: number;
 }
 
 interface SkyAgGridTextProperties {
+    /**
+     * The maximum length of the text that users can enter into the cell.
+     */
     maxlength?: number;
 }
 
@@ -578,6 +756,9 @@ declare class SkyAgGridCellEditorAutocompleteComponent implements ICellEditorAng
  * @internal
  */
 interface SkyCellEditorCurrencyParams extends ICellEditorParams {
+    /**
+     * The parameters provided to the currency cell editor.
+     */
     skyComponentProperties?: SkyAgGridCurrencyProperties;
 }
 
@@ -684,6 +865,9 @@ declare class SkyAgGridCellEditorLookupComponent implements ICellEditorAngularCo
  * @internal
  */
 interface SkyCellEditorNumberParams extends ICellEditorParams {
+    /**
+     * The parameters provided to the number cell editor.
+     */
     skyComponentProperties?: SkyAgGridNumberProperties;
 }
 
@@ -722,6 +906,9 @@ declare class SkyAgGridCellEditorNumberComponent implements ICellEditorAngularCo
  * @internal
  */
 interface SkyCellEditorTextParams extends ICellEditorParams {
+    /**
+     * The parameters provided to the text cell editor.
+     */
     skyComponentProperties?: SkyAgGridTextProperties;
 }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@skyux/ag-grid",
-  "version": "13.0.0",
+  "version": "13.0.1",
   "author": "Blackbaud, Inc.",
   "keywords": [
     "blackbaud",
@@ -31,18 +31,18 @@
     "@angular/common": "^20.3.0",
     "@angular/core": "^20.3.0",
     "@angular/forms": "^20.3.0",
-    "@skyux/autonumeric": "13.0.0",
-    "@skyux/core": "13.0.0",
-    "@skyux/data-manager": "13.0.0",
-    "@skyux/datetime": "13.0.0",
-    "@skyux/forms": "13.0.0",
-    "@skyux/i18n": "13.0.0",
-    "@skyux/icon": "13.0.0",
-    "@skyux/indicators": "13.0.0",
-    "@skyux/layout": "13.0.0",
-    "@skyux/lookup": "13.0.0",
-    "@skyux/popovers": "13.0.0",
-    "@skyux/theme": "13.0.0",
+    "@skyux/autonumeric": "13.0.1",
+    "@skyux/core": "13.0.1",
+    "@skyux/data-manager": "13.0.1",
+    "@skyux/datetime": "13.0.1",
+    "@skyux/forms": "13.0.1",
+    "@skyux/i18n": "13.0.1",
+    "@skyux/icon": "13.0.1",
+    "@skyux/indicators": "13.0.1",
+    "@skyux/layout": "13.0.1",
+    "@skyux/lookup": "13.0.1",
+    "@skyux/popovers": "13.0.1",
+    "@skyux/theme": "13.0.1",
     "ag-grid-angular": "^34.2.0",
     "ag-grid-community": "^34.2.0"
   },