@skyux/ag-grid 12.22.0 → 13.0.0-alpha.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (62) hide show
  1. package/fesm2022/skyux-ag-grid.mjs +189 -100
  2. package/fesm2022/skyux-ag-grid.mjs.map +1 -1
  3. package/index.d.ts +937 -42
  4. package/package.json +18 -18
  5. package/lib/modules/ag-grid/ag-grid-adapter.service.d.ts +0 -16
  6. package/lib/modules/ag-grid/ag-grid-data-manager-adapter.directive.d.ts +0 -19
  7. package/lib/modules/ag-grid/ag-grid-row-delete-context.d.ts +0 -20
  8. package/lib/modules/ag-grid/ag-grid-row-delete.component.d.ts +0 -23
  9. package/lib/modules/ag-grid/ag-grid-row-delete.directive.d.ts +0 -27
  10. package/lib/modules/ag-grid/ag-grid-wrapper.component.d.ts +0 -39
  11. package/lib/modules/ag-grid/ag-grid.module.d.ts +0 -12
  12. package/lib/modules/ag-grid/ag-grid.service.d.ts +0 -29
  13. package/lib/modules/ag-grid/apply-lookup-properties-defaults.d.ts +0 -5
  14. package/lib/modules/ag-grid/cell-editors/cell-editor-autocomplete/cell-editor-autocomplete.component.d.ts +0 -24
  15. package/lib/modules/ag-grid/cell-editors/cell-editor-currency/cell-editor-currency.component.d.ts +0 -43
  16. package/lib/modules/ag-grid/cell-editors/cell-editor-datepicker/cell-editor-datepicker.component.d.ts +0 -42
  17. package/lib/modules/ag-grid/cell-editors/cell-editor-lookup/cell-editor-lookup.component.d.ts +0 -29
  18. package/lib/modules/ag-grid/cell-editors/cell-editor-number/cell-editor-number.component.d.ts +0 -35
  19. package/lib/modules/ag-grid/cell-editors/cell-editor-text/cell-editor-text.component.d.ts +0 -33
  20. package/lib/modules/ag-grid/cell-renderers/cell-renderer-currency/cell-renderer-currency-validator.component.d.ts +0 -22
  21. package/lib/modules/ag-grid/cell-renderers/cell-renderer-currency/cell-renderer-currency.component.d.ts +0 -27
  22. package/lib/modules/ag-grid/cell-renderers/cell-renderer-lookup/cell-renderer-lookup.component.d.ts +0 -17
  23. package/lib/modules/ag-grid/cell-renderers/cell-renderer-row-selector/cell-renderer-row-selector.component.d.ts +0 -32
  24. package/lib/modules/ag-grid/cell-renderers/cell-renderer-template/cell-renderer-template-context.type.d.ts +0 -4
  25. package/lib/modules/ag-grid/cell-renderers/cell-renderer-template/cell-renderer-template.component.d.ts +0 -22
  26. package/lib/modules/ag-grid/cell-renderers/cell-renderer-validator-tooltip/cell-renderer-validator-tooltip.component.d.ts +0 -20
  27. package/lib/modules/ag-grid/cell-validator/ag-grid-cell-validator-tooltip.component.d.ts +0 -19
  28. package/lib/modules/ag-grid/header/header-group.component.d.ts +0 -22
  29. package/lib/modules/ag-grid/header/header.component.d.ts +0 -27
  30. package/lib/modules/ag-grid/icons/icon-map.d.ts +0 -5
  31. package/lib/modules/ag-grid/loading/loading.component.d.ts +0 -9
  32. package/lib/modules/ag-grid/types/ag-grid-row-delete-cancel-args.d.ts +0 -9
  33. package/lib/modules/ag-grid/types/ag-grid-row-delete-confirm-args.d.ts +0 -9
  34. package/lib/modules/ag-grid/types/autocomplete-properties.d.ts +0 -21
  35. package/lib/modules/ag-grid/types/cell-class.d.ts +0 -18
  36. package/lib/modules/ag-grid/types/cell-editor-autocomplete-params.d.ts +0 -5
  37. package/lib/modules/ag-grid/types/cell-editor-currency-params.d.ts +0 -8
  38. package/lib/modules/ag-grid/types/cell-editor-datepicker-params.d.ts +0 -5
  39. package/lib/modules/ag-grid/types/cell-editor-initial-action.d.ts +0 -11
  40. package/lib/modules/ag-grid/types/cell-editor-lookup-params.d.ts +0 -5
  41. package/lib/modules/ag-grid/types/cell-editor-number-params.d.ts +0 -8
  42. package/lib/modules/ag-grid/types/cell-editor-text-params.d.ts +0 -8
  43. package/lib/modules/ag-grid/types/cell-editor-utils.d.ts +0 -10
  44. package/lib/modules/ag-grid/types/cell-renderer-currency-params.d.ts +0 -9
  45. package/lib/modules/ag-grid/types/cell-renderer-lookup-params.d.ts +0 -8
  46. package/lib/modules/ag-grid/types/cell-renderer-validator-params.d.ts +0 -8
  47. package/lib/modules/ag-grid/types/cell-type.d.ts +0 -102
  48. package/lib/modules/ag-grid/types/currency-properties.d.ts +0 -5
  49. package/lib/modules/ag-grid/types/datepicker-properties.d.ts +0 -13
  50. package/lib/modules/ag-grid/types/header-class.d.ts +0 -7
  51. package/lib/modules/ag-grid/types/header-group-info.d.ts +0 -27
  52. package/lib/modules/ag-grid/types/header-group-params.d.ts +0 -14
  53. package/lib/modules/ag-grid/types/header-info.d.ts +0 -27
  54. package/lib/modules/ag-grid/types/header-params.d.ts +0 -20
  55. package/lib/modules/ag-grid/types/last-focused.cell.d.ts +0 -4
  56. package/lib/modules/ag-grid/types/lookup-properties.d.ts +0 -27
  57. package/lib/modules/ag-grid/types/number-properties.d.ts +0 -4
  58. package/lib/modules/ag-grid/types/sky-grid-options.d.ts +0 -16
  59. package/lib/modules/ag-grid/types/text-properties.d.ts +0 -3
  60. package/lib/modules/ag-grid/types/validator-properties.d.ts +0 -18
  61. package/lib/modules/shared/sky-ag-grid-resources.module.d.ts +0 -10
  62. package/lib/styles/ag-grid-theme.d.ts +0 -7
@@ -1,19 +0,0 @@
1
- import { SkyPopoverMessage } from '@skyux/popovers';
2
- import { Subject } from 'rxjs';
3
- import { SkyCellRendererValidatorParams } from '../types/cell-renderer-validator-params';
4
- import * as i0 from "@angular/core";
5
- /**
6
- * @internal
7
- */
8
- export declare class SkyAgGridCellValidatorTooltipComponent {
9
- #private;
10
- set params(value: SkyCellRendererValidatorParams | undefined);
11
- popoverMessageStream: Subject<SkyPopoverMessage>;
12
- validatorMessage: string | undefined;
13
- cellRendererParams: SkyCellRendererValidatorParams | undefined;
14
- protected readonly showValidatorMessage: import("@angular/core").WritableSignal<boolean>;
15
- hidePopover(): void;
16
- showPopover(): void;
17
- static ɵfac: i0.ɵɵFactoryDeclaration<SkyAgGridCellValidatorTooltipComponent, never>;
18
- static ɵcmp: i0.ɵɵComponentDeclaration<SkyAgGridCellValidatorTooltipComponent, "sky-ag-grid-cell-validator-tooltip", never, { "params": { "alias": "params"; "required": false; }; }, {}, never, ["*"], true, never>;
19
- }
@@ -1,22 +0,0 @@
1
- import { AfterViewInit, ElementRef, OnDestroy } from '@angular/core';
2
- import { IHeaderGroupAngularComp } from 'ag-grid-angular';
3
- import { Observable } from 'rxjs';
4
- import { SkyAgGridHeaderGroupParams } from '../types/header-group-params';
5
- import * as i0 from "@angular/core";
6
- /**
7
- * @internal
8
- */
9
- export declare class SkyAgGridHeaderGroupComponent implements IHeaderGroupAngularComp, OnDestroy, AfterViewInit {
10
- #private;
11
- inlineHelpContainer: ElementRef | undefined;
12
- protected params: SkyAgGridHeaderGroupParams | undefined;
13
- protected isExpandable$: Observable<boolean>;
14
- protected isExpanded$: Observable<boolean>;
15
- constructor();
16
- ngAfterViewInit(): void;
17
- ngOnDestroy(): void;
18
- agInit(params: SkyAgGridHeaderGroupParams | undefined): void;
19
- setExpanded($event: boolean): void;
20
- static ɵfac: i0.ɵɵFactoryDeclaration<SkyAgGridHeaderGroupComponent, never>;
21
- static ɵcmp: i0.ɵɵComponentDeclaration<SkyAgGridHeaderGroupComponent, "sky-header-group", never, {}, {}, never, never, true, never>;
22
- }
@@ -1,27 +0,0 @@
1
- import { AfterViewInit, ElementRef, OnDestroy } from '@angular/core';
2
- import { IHeaderAngularComp } from 'ag-grid-angular';
3
- import { BehaviorSubject } from 'rxjs';
4
- import { SkyAgGridHeaderParams } from '../types/header-params';
5
- import * as i0 from "@angular/core";
6
- /**
7
- * @internal
8
- */
9
- export declare class SkyAgGridHeaderComponent implements IHeaderAngularComp, OnDestroy, AfterViewInit {
10
- #private;
11
- readonly filterEnabled$: BehaviorSubject<boolean>;
12
- protected readonly accessibleHeaderText: import("@angular/core").Signal<string | undefined>;
13
- protected inlineHelpContainer: ElementRef | undefined;
14
- protected readonly params: import("@angular/core").WritableSignal<SkyAgGridHeaderParams | undefined>;
15
- protected sorted: string;
16
- protected readonly sortOrder$: BehaviorSubject<"desc" | "asc" | undefined>;
17
- protected readonly sortIndexDisplay$: BehaviorSubject<string>;
18
- protected displayName: import("@angular/core").Signal<string | undefined>;
19
- ngAfterViewInit(): void;
20
- ngOnDestroy(): void;
21
- agInit(params: SkyAgGridHeaderParams | undefined): void;
22
- onMenuClick($event: Event): void;
23
- onSortRequested(event: MouseEvent): void;
24
- refresh(params: SkyAgGridHeaderParams): boolean;
25
- static ɵfac: i0.ɵɵFactoryDeclaration<SkyAgGridHeaderComponent, never>;
26
- static ɵcmp: i0.ɵɵComponentDeclaration<SkyAgGridHeaderComponent, "sky-ag-grid-header", never, {}, {}, never, never, true, never>;
27
- }
@@ -1,5 +0,0 @@
1
- export declare const iconMap: Record<string, {
2
- name: string;
3
- size: number;
4
- }>;
5
- export type IconMapType = typeof iconMap;
@@ -1,9 +0,0 @@
1
- import { ILoadingOverlayAngularComp } from 'ag-grid-angular';
2
- import { ILoadingOverlayParams } from 'ag-grid-community';
3
- import * as i0 from "@angular/core";
4
- export declare class SkyAgGridLoadingComponent implements ILoadingOverlayAngularComp {
5
- agInit(_params: ILoadingOverlayParams): void;
6
- refresh(_params: ILoadingOverlayParams): void;
7
- static ɵfac: i0.ɵɵFactoryDeclaration<SkyAgGridLoadingComponent, never>;
8
- static ɵcmp: i0.ɵɵComponentDeclaration<SkyAgGridLoadingComponent, "sky-ag-grid-loading", never, {}, {}, never, never, true, never>;
9
- }
@@ -1,9 +0,0 @@
1
- /**
2
- * Information regarding a row whose deletion has been cancelled.
3
- */
4
- export interface SkyAgGridRowDeleteCancelArgs {
5
- /**
6
- * The id of the data in the row whose deletion has been cancelled.
7
- */
8
- id: string;
9
- }
@@ -1,9 +0,0 @@
1
- /**
2
- * Information regarding a row whose deletion has been confirmed.
3
- */
4
- export interface SkyAgGridRowDeleteConfirmArgs {
5
- /**
6
- * The id of the data in the row whose deletion has been confirmed.
7
- */
8
- id: string;
9
- }
@@ -1,21 +0,0 @@
1
- import { TemplateRef } from '@angular/core';
2
- import { SkyAutocompleteSelectionChange } from '@skyux/lookup';
3
- export interface SkyAgGridAutocompleteProperties {
4
- allowAnyValue?: boolean;
5
- data?: unknown[];
6
- debounceTime?: number;
7
- descriptorProperty?: string;
8
- highlightSearchText?: boolean;
9
- propertiesToSearch?: string[];
10
- search?: (searchText: string, data?: unknown[]) => unknown[] | Promise<unknown[]>;
11
- searchFilters?: ((searchText: string, item: unknown) => boolean)[];
12
- searchResultsLimit?: number;
13
- searchResultTemplate?: TemplateRef<unknown>;
14
- searchTextMinimumCharacters?: number;
15
- selectionChange?: (event: SkyAutocompleteSelectionChange) => void;
16
- }
17
- /**
18
- * @deprecated Use SkyAgGridAutocompleteProperties instead.
19
- */
20
- export interface SkyAutocompleteProperties extends SkyAgGridAutocompleteProperties {
21
- }
@@ -1,18 +0,0 @@
1
- /**
2
- * @internal
3
- */
4
- export declare enum SkyCellClass {
5
- Autocomplete = "sky-ag-grid-cell-autocomplete",
6
- Currency = "sky-ag-grid-cell-currency",
7
- Date = "sky-ag-grid-cell-date",
8
- Editable = "sky-ag-grid-cell-editable",
9
- Invalid = "sky-ag-grid-cell-invalid",
10
- Lookup = "sky-ag-grid-cell-lookup",
11
- Number = "sky-ag-grid-cell-number",
12
- RightAligned = "sky-ag-grid-cell-right-aligned",
13
- RowSelector = "sky-ag-grid-cell-row-selector",
14
- Template = "sky-ag-grid-cell-template",
15
- Text = "sky-ag-grid-cell-text",
16
- Uneditable = "sky-ag-grid-cell-uneditable",
17
- Validator = "sky-ag-grid-cell-validator"
18
- }
@@ -1,5 +0,0 @@
1
- import { ICellEditorParams } from 'ag-grid-community';
2
- import { SkyAgGridAutocompleteProperties, SkyAutocompleteProperties } from './autocomplete-properties';
3
- export interface SkyCellEditorAutocompleteParams extends ICellEditorParams {
4
- skyComponentProperties?: SkyAutocompleteProperties | SkyAgGridAutocompleteProperties;
5
- }
@@ -1,8 +0,0 @@
1
- import { ICellEditorParams } from 'ag-grid-community';
2
- import type { SkyAgGridCurrencyProperties } from './currency-properties';
3
- /**
4
- * @internal
5
- */
6
- export interface SkyCellEditorCurrencyParams extends ICellEditorParams {
7
- skyComponentProperties?: SkyAgGridCurrencyProperties;
8
- }
@@ -1,5 +0,0 @@
1
- import { ICellEditorParams } from 'ag-grid-community';
2
- import { SkyAgGridDatepickerProperties, SkyDatepickerProperties } from './datepicker-properties';
3
- export interface SkyCellEditorDatepickerParams extends ICellEditorParams {
4
- skyComponentProperties?: SkyDatepickerProperties | SkyAgGridDatepickerProperties;
5
- }
@@ -1,11 +0,0 @@
1
- /** The initial action that a cell editor should take when initialized. */
2
- export declare enum SkyAgGridCellEditorInitialAction {
3
- /** The cell should be cleared. */
4
- Delete = 0,
5
- /** The cell value should be highlighted. */
6
- Highlighted = 1,
7
- /** The cell value should be replaced with the initializing value. */
8
- Replace = 2,
9
- /** The cell should not be modified and the cursor is placed at the end of the value. */
10
- Untouched = 3
11
- }
@@ -1,5 +0,0 @@
1
- import { ICellEditorParams } from 'ag-grid-community';
2
- import { SkyAgGridLookupProperties } from './lookup-properties';
3
- export interface SkyCellEditorLookupParams extends ICellEditorParams {
4
- skyComponentProperties?: SkyAgGridLookupProperties;
5
- }
@@ -1,8 +0,0 @@
1
- import { ICellEditorParams } from 'ag-grid-community';
2
- import { SkyAgGridNumberProperties } from './number-properties';
3
- /**
4
- * @internal
5
- */
6
- export interface SkyCellEditorNumberParams extends ICellEditorParams {
7
- skyComponentProperties?: SkyAgGridNumberProperties;
8
- }
@@ -1,8 +0,0 @@
1
- import { ICellEditorParams } from 'ag-grid-community';
2
- import { SkyAgGridTextProperties } from './text-properties';
3
- /**
4
- * @internal
5
- */
6
- export interface SkyCellEditorTextParams extends ICellEditorParams {
7
- skyComponentProperties?: SkyAgGridTextProperties;
8
- }
@@ -1,10 +0,0 @@
1
- import { ICellEditorParams } from 'ag-grid-community';
2
- import { SkyAgGridCellEditorInitialAction } from './cell-editor-initial-action';
3
- export declare class SkyAgGridCellEditorUtils {
4
- /**
5
- * Gets the initial action that a cell editor should take when initialized.
6
- * @param params The editor's initializing parameters.
7
- */
8
- static getEditorInitialAction(params: ICellEditorParams | undefined): SkyAgGridCellEditorInitialAction;
9
- static subtractOrZero(minuend: number | null | undefined, subtrahend: number): number;
10
- }
@@ -1,9 +0,0 @@
1
- import { NumericOptions } from '@skyux/core';
2
- import { ICellRendererParams } from 'ag-grid-community';
3
- import { SkyAgGridValidatorProperties } from './validator-properties';
4
- /**
5
- * @internal
6
- */
7
- export interface SkyCellRendererCurrencyParams extends ICellRendererParams {
8
- skyComponentProperties?: NumericOptions & SkyAgGridValidatorProperties;
9
- }
@@ -1,8 +0,0 @@
1
- import { ICellRendererParams } from 'ag-grid-community';
2
- import { SkyAgGridLookupProperties } from './lookup-properties';
3
- /**
4
- * @internal
5
- */
6
- export interface SkyCellRendererLookupParams extends ICellRendererParams {
7
- skyComponentProperties?: SkyAgGridLookupProperties;
8
- }
@@ -1,8 +0,0 @@
1
- import { ICellRendererParams } from 'ag-grid-community';
2
- import { SkyAgGridValidatorProperties } from './validator-properties';
3
- /**
4
- * @internal
5
- */
6
- export interface SkyCellRendererValidatorParams extends ICellRendererParams {
7
- skyComponentProperties?: SkyAgGridValidatorProperties;
8
- }
@@ -1,102 +0,0 @@
1
- /**
2
- * These column types can be used by setting the AG Grid [column definition `type`](https://www.ag-grid.com/angular-data-grid/column-properties/#reference-editing) to one of the following values.
3
- * Any [SKY UX component](https://developer.blackbaud.com/skyux/components) can be made into a [cell editor](https://www.ag-grid.com/javascript-grid-cell-editor/) or [cell renderer](https://www.ag-grid.com/javascript-grid-cell-rendering-components/) component. If you would like to use a component that does not have a column definition yet, please consider [contributing it](https://developer.blackbaud.com/skyux/contribute/contribution-process) to the SKY UX data entry grid module, or [file an issue](https://developer.blackbaud.com/skyux/contribute/contribution-process/file-issue) in the [`@skyux/ag-grid` repo](https://github.com/blackbaud/skyux-ag-grid).
4
- */
5
- export declare enum SkyCellType {
6
- /**
7
- * **Edit mode**
8
- *
9
- * Cells in the column will be edited as [SKY UX autocomplete components](https://developer.blackbaud.com/skyux/components/autocomplete). You can set any of the autocomplete component's properties by passing `SkyCellEditorAutocompleteParams` in the [column definition's `cellEditorParams` property](https://www.ag-grid.com/angular-data-grid/column-properties/#reference-editing). These params can be updated as other cell edits are made or [provided dynamically](https://www.ag-grid.com/javascript-grid-cell-editing/#dynamic-parameters) based on other cell values. See the demo for an example. Text can be entered and a value selected from the provided list.
10
- *
11
- * **Read-only mode**
12
- *
13
- * Cells the column will display the currently selected value's name property by default. If the autocomplete needs to show a different property or needs to be formatted in any way, you can [define a `valueFormatter`](https://www.ag-grid.com/javascript-grid-value-formatters/) on the column definition.
14
- */
15
- Autocomplete = "skyCellAutocomplete",
16
- /**
17
- * **Edit mode**
18
- *
19
- * Cells in the column will be edited as a currency amount.
20
- *
21
- * **Read-only mode**
22
- *
23
- * Formats the display as currency using [SKY UX numeric components](https://developer.blackbaud.com/skyux/components/numeric).
24
- */
25
- Currency = "skyCellCurrency",
26
- /**
27
- * **Edit and read-only modes**
28
- *
29
- * Combines SkyCellType.Currency and SkyCellType.Validator, where the value is displayed as a currency and passed to a validator function.
30
- */
31
- CurrencyValidator = "skyCellCurrencyValidator",
32
- /**
33
- * **Edit mode**
34
- *
35
- * Cells in the column will be edited as [SKY UX datepicker components](https://developer.blackbaud.com/skyux/components/datepicker). You can set any of the datepicker component's properties by passing `SkyCellEditorDatepickerParams` in the [column definition's `cellEditorParams` property](https://www.ag-grid.com/angular-data-grid/column-properties/#reference-editing). These params can be updated as other cell edits are made or [provided dynamically](https://www.ag-grid.com/javascript-grid-cell-editing/#dynamic-parameters) based on other cell values. See the demo for an example. Date values can be entered.
36
- *
37
- * **Read-only mode**
38
- *
39
- * Cells in the column will display the currently selected date formatted as `MM-DD-YYYY`, or the date format of the locale passed to `getGridOptions()`. If you would like to overwrite this format, you can [define a `valueFormatter`](https://www.ag-grid.com/javascript-grid-value-formatters/) on the column definition. See the demo for an example.
40
- */
41
- Date = "skyCellDate",
42
- /**
43
- * **Edit mode**
44
- *
45
- * Cells in the column will be edited as [SKY UX lookup components](https://developer.blackbaud.com/skyux-v5/components/lookup). You can set any of the lookup component's properties by passing `SkyCellEditorLookupParams` in the [column definition's `cellEditorParams` property](https://www.ag-grid.com/angular-data-grid/column-properties/#reference-editing). These params can be updated as other cell edits are made or [provided dynamically](https://www.ag-grid.com/javascript-grid-cell-editing/#dynamic-parameters) based on other cell values. See the demo for an example. Text can be entered and a value selected from the provided list.
46
- *
47
- * **Read-only mode**
48
- *
49
- * Cells the column will display, by default, either: the name(s) of the selected value(s) if there are less than 6, or a summary count of the values if there are more than 5. If the lookup needs to show a different property or needs to be formatted in any way, you can [define a `valueFormatter`](https://www.ag-grid.com/javascript-grid-value-formatters/) on the column definition.
50
- */
51
- Lookup = "skyCellLookup",
52
- /**
53
- * **Edit mode**
54
- *
55
- * Cells in the column will be edited as HTML number `inputs`. Only numbers can be entered.
56
- *
57
- * **Read-only mode**
58
- *
59
- * Cells in the column will render as the number value.
60
- */
61
- Number = "skyCellNumber",
62
- /**
63
- * **Edit and read-only modes**
64
- *
65
- * Combines SkyCellType.Number and SkyCellType.Validator, where the value is displayed as a number and passed to a validator function.
66
- */
67
- NumberValidator = "skyCellNumberValidator",
68
- /**
69
- * **Edit and read-only modes**
70
- *
71
- * The header and cells in the column will render right aligned.
72
- */
73
- RightAligned = "skyCellRightAligned",
74
- /**
75
- * **Edit and read-only modes**
76
- *
77
- * Cells in the column will render as [SKY UX checkbox components](https://developer.blackbaud.com/skyux/components/checkbox). It allows the user to select multiple rows, and adds a highlight to selected rows. The [Ag Grid `rowNode`](https://www.ag-grid.com/javascript-grid-row-node/) will be updated to reflect the selected state.
78
- */
79
- RowSelector = "skyCellRowSelector",
80
- /**
81
- * **Read-only mode**
82
- *
83
- * Cells in the column will render in a `TemplateRef` passed in the column definition's `cellRendererParams.template` property, with `value` and `row` context. See the demo for an example.
84
- */
85
- Template = "skyCellTemplate",
86
- /**
87
- * **Edit mode**
88
- *
89
- * Cells in the column will be edited as HTML text `inputs`. Any characters can be entered.
90
- *
91
- * **Read-only mode**
92
- *
93
- * Cells in the column will render as their string value.
94
- */
95
- Text = "skyCellText",
96
- /**
97
- * **Edit and read-only modes**
98
- *
99
- * Cells in the column will be passed to a validator function that flags erroneous entries. You can set the validator function and message by passing a `SkyAgGridValidatorProperties` object as `skyComponentProperties` to [column definition's `cellRendererParams` property](https://www.ag-grid.com/angular-data-grid/column-properties/#reference-editing), like `skyComponentProperties.validator` and `skyComponentProperties.validatorMessage`. SkyCellType.Validator can be combined with other cell types, such as SkyCellType.Autocomplete or SkyCellType.Date, by using the array syntax for the [column definition's `type` property](https://www.ag-grid.com/angular-data-grid/column-properties/#reference-editing).
100
- */
101
- Validator = "skyCellValidator"
102
- }
@@ -1,5 +0,0 @@
1
- export interface SkyAgGridCurrencyProperties {
2
- currencySymbol?: string;
3
- decimalPlaces?: number | string;
4
- negativeBracketsTypeOnBlur?: '(,)' | '[,]' | '<,>' | '{,}' | '〈,〉' | '「,」' | '⸤,⸥' | '⟦,⟧' | '‹,›' | '«,»' | null;
5
- }
@@ -1,13 +0,0 @@
1
- export interface SkyAgGridDatepickerProperties {
2
- dateFormat?: string;
3
- disabled?: boolean;
4
- maxDate?: Date;
5
- minDate?: Date;
6
- skyDatepickerNoValidate?: boolean;
7
- startingDay?: number;
8
- }
9
- /**
10
- * @deprecated Use SkyAgGridDatepickerProperties instead.
11
- */
12
- export interface SkyDatepickerProperties extends SkyAgGridDatepickerProperties {
13
- }
@@ -1,7 +0,0 @@
1
- /**
2
- * @internal
3
- */
4
- export declare enum SkyHeaderClass {
5
- Resizable = "sky-ag-grid-header-resizable",
6
- RightAligned = "sky-ag-grid-header-right-aligned"
7
- }
@@ -1,27 +0,0 @@
1
- import { ColumnGroup } from 'ag-grid-community';
2
- import * as i0 from "@angular/core";
3
- /**
4
- * To display a help button beside the column group header, create a component containing
5
- * [`sky-help-inline`](https://developer.blackbaud.com/skyux/components/help-inline),
6
- * and inject SkyAgGridHeaderGroupInfo to access the column group
7
- * information, such as display name.
8
- * Add the component to the `headerGroupComponentParams.inlineHelpComponent`
9
- * property of the [column group definition](https://www.ag-grid.com/angular-data-grid/column-groups/).
10
- * @see SkyAgGridHeaderGroupParams
11
- */
12
- export declare class SkyAgGridHeaderGroupInfo {
13
- /**
14
- * [Column group information from AG Grid](https://www.ag-grid.com/angular-data-grid/column-object-group/).
15
- */
16
- columnGroup: ColumnGroup | undefined;
17
- /**
18
- * Display name of the column group.
19
- */
20
- displayName: string | undefined;
21
- /**
22
- * AG Grid's [`context` field](https://www.ag-grid.com/angular-data-grid/context/).
23
- */
24
- context: any;
25
- static ɵfac: i0.ɵɵFactoryDeclaration<SkyAgGridHeaderGroupInfo, never>;
26
- static ɵprov: i0.ɵɵInjectableDeclaration<SkyAgGridHeaderGroupInfo>;
27
- }
@@ -1,14 +0,0 @@
1
- import { Type } from '@angular/core';
2
- import { IHeaderGroupParams } from 'ag-grid-community';
3
- /**
4
- * Interface to use for the
5
- * [`headerGroupComponentParams`](https://www.ag-grid.com/angular-data-grid/column-properties/#reference-groupsHeader-headerGroupComponentParams)
6
- * property on `ColGroupDef`.
7
- */
8
- export interface SkyAgGridHeaderGroupParams extends IHeaderGroupParams {
9
- /**
10
- * The component to display as inline help beside the column group header.
11
- * @see SkyAgGridHeaderGroupInfo
12
- */
13
- inlineHelpComponent?: Type<unknown>;
14
- }
@@ -1,27 +0,0 @@
1
- import { Column } from 'ag-grid-community';
2
- import * as i0 from "@angular/core";
3
- /**
4
- * To display a help button beside the column header, create a component containing
5
- * [`sky-help-inline`](https://developer.blackbaud.com/skyux/components/help-inline),
6
- * and inject SkyAgGridHeaderInfo to access the column information, such
7
- * as display name.
8
- * Add the component to the `headerComponentParams.inlineHelpComponent`
9
- * property of the [column definition](https://www.ag-grid.com/angular-data-grid/column-definitions/).
10
- * @see SkyAgGridHeaderParams
11
- */
12
- export declare class SkyAgGridHeaderInfo {
13
- /**
14
- * [Column information from AG Grid](https://www.ag-grid.com/angular-data-grid/column-object/).
15
- */
16
- column: Column | undefined;
17
- /**
18
- * Display name of the column.
19
- */
20
- displayName: string | undefined;
21
- /**
22
- * AG Grid's [`context` field](https://www.ag-grid.com/angular-data-grid/context/).
23
- */
24
- context: any;
25
- static ɵfac: i0.ɵɵFactoryDeclaration<SkyAgGridHeaderInfo, never>;
26
- static ɵprov: i0.ɵɵInjectableDeclaration<SkyAgGridHeaderInfo>;
27
- }
@@ -1,20 +0,0 @@
1
- import { Type } from '@angular/core';
2
- import { IHeaderParams } from 'ag-grid-community';
3
- /**
4
- * Interface to use for the
5
- * [`headerComponentParams`](https://www.ag-grid.com/angular-data-grid/column-properties/#reference-header-headerComponentParams)
6
- * property on `ColDef`.
7
- */
8
- export interface SkyAgGridHeaderParams extends IHeaderParams {
9
- /**
10
- * Hides the column header text.
11
- * Each column should have a `headerName` defined in the column definition for accessibility.
12
- * This option allows that text to be hidden from view while still being available to screen readers.
13
- */
14
- headerHidden?: boolean;
15
- /**
16
- * The component to display as inline help beside the column header.
17
- * @see SkyAgGridHeaderInfo
18
- */
19
- inlineHelpComponent?: Type<unknown>;
20
- }
@@ -1,4 +0,0 @@
1
- export interface LastFocusedCell {
2
- rowIndex: number | null;
3
- column: string;
4
- }
@@ -1,27 +0,0 @@
1
- import { TemplateRef } from '@angular/core';
2
- import { SkyAutocompleteSearchAsyncArgs, SkyAutocompleteSearchFunction, SkyAutocompleteSearchFunctionFilter, SkyLookupAddClickEventArgs, SkyLookupSelectModeType, SkyLookupShowMoreConfig } from '@skyux/lookup';
3
- export interface SkyAgGridLookupProperties {
4
- addClick?: (args: SkyLookupAddClickEventArgs) => void;
5
- ariaLabel?: string;
6
- ariaLabelledBy?: string;
7
- /** @deprecated */
8
- autocompleteAttribute?: string;
9
- data?: unknown[];
10
- debounceTime?: number;
11
- descriptorProperty?: string;
12
- disabled?: boolean;
13
- enableShowMore?: boolean;
14
- idProperty?: string;
15
- placeholderText?: string;
16
- propertiesToSearch?: string[];
17
- search?: SkyAutocompleteSearchFunction;
18
- searchAsync?: (args: SkyAutocompleteSearchAsyncArgs) => void;
19
- searchFilters?: SkyAutocompleteSearchFunctionFilter[];
20
- searchResultsLimit?: number;
21
- searchResultTemplate?: TemplateRef<unknown>;
22
- searchTextMinimumCharacters?: number;
23
- selectMode?: SkyLookupSelectModeType;
24
- showAddButton?: boolean;
25
- showMoreConfig?: SkyLookupShowMoreConfig;
26
- wrapperClass?: string;
27
- }
@@ -1,4 +0,0 @@
1
- export interface SkyAgGridNumberProperties {
2
- max?: number;
3
- min?: number;
4
- }
@@ -1,16 +0,0 @@
1
- import { GridOptions } from 'ag-grid-community';
2
- export interface SkyGetGridOptionsArgs {
3
- /**
4
- * The [AG Grid `gridOptions`](https://www.ag-grid.com/javascript-grid-properties/) that override default SKY UX `gridOptions`. SKY UX column types for components and column `cellClassRules` enforce required cell styling and cannot be overridden.
5
- */
6
- gridOptions: GridOptions;
7
- /**
8
- * The locale for location-specific formatting, such as date values for the `SkyCellType.Date` column.
9
- */
10
- locale?: string;
11
- /**
12
- * The format to use for formatting date strings in the `SkyCellType.Date` column.
13
- * @default "shortDate"
14
- */
15
- dateFormat?: string;
16
- }
@@ -1,3 +0,0 @@
1
- export interface SkyAgGridTextProperties {
2
- maxlength?: number;
3
- }
@@ -1,18 +0,0 @@
1
- import type { Observable } from 'rxjs';
2
- export interface SkyAgGridValidatorProperties {
3
- /**
4
- * An optional function that returns an observable that emits a string. Can be used with resources to localize the
5
- * value displayed in the cell.
6
- */
7
- valueResourceObservable?: (value: unknown, data?: unknown, rowIndex?: number | null) => Observable<string>;
8
- /**
9
- * A function that returns true if the value is valid, or false if it is not. Invalid values
10
- * will be highlighted and display a validation message.
11
- */
12
- validator?: (value: unknown, data?: unknown, rowIndex?: number | null) => boolean;
13
- /**
14
- * Either a string or a function that returns a string. The message to display when the value is
15
- * invalid.
16
- */
17
- validatorMessage?: string | ((value: unknown, data?: unknown, rowIndex?: number | null) => string);
18
- }
@@ -1,10 +0,0 @@
1
- import * as i0 from "@angular/core";
2
- import * as i1 from "@skyux/i18n";
3
- /**
4
- * Import into any component library module that needs to use resource strings.
5
- */
6
- export declare class SkyAgGridResourcesModule {
7
- static ɵfac: i0.ɵɵFactoryDeclaration<SkyAgGridResourcesModule, never>;
8
- static ɵmod: i0.ɵɵNgModuleDeclaration<SkyAgGridResourcesModule, never, never, [typeof i1.SkyI18nModule]>;
9
- static ɵinj: i0.ɵɵInjectorDeclaration<SkyAgGridResourcesModule>;
10
- }
@@ -1,7 +0,0 @@
1
- import { SkyThemeSettings } from '@skyux/theme';
2
- import { Theme } from 'ag-grid-community';
3
- export declare function getSkyAgGridTheme(grid: 'data-entry-grid' | 'data-grid'): Theme;
4
- type SkyAgGridThemeType = `ag-theme-sky-${'data-entry-grid' | 'data-grid'}-${'default' | 'modern-light' | 'modern-light-compact'}`;
5
- export declare function agGridThemeIsCompact(themeSettings: SkyThemeSettings | undefined, compactLayout: boolean): boolean;
6
- export declare function getSkyAgGridThemeClassName(editable: boolean, themeSettings: SkyThemeSettings | undefined, compactLayout: boolean): SkyAgGridThemeType;
7
- export {};