You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: .github/CONTRIBUTING.md
+13-3Lines changed: 13 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -170,17 +170,27 @@ Write migrations.
170
170
171
171
## Deprecating methods
172
172
When a method is deprecated a few steps have to be done:
173
-
1. Add deprecation warning message by decorating the method with `@DeprecateMethod` decorator from `deprecateDecorators.ts` file.
173
+
1. Add the `@deprecated` tag at the begging of the method description followed by the version in which the method has been deprecated and what can be used instead. Example:
174
+
```ts
175
+
/**
176
+
* @deprecated in version 12.1.0. Use 'data' instead
177
+
*
178
+
* The data record that populates the row
179
+
*/
180
+
publicgetRowData(): any {
181
+
returnthis.data;
182
+
}
183
+
```
174
184
2. Ensure that the deprecated method is no longer used in IgniteUI for Angular codebase, samples and documentation snippets.
175
185
3. Write migrations.
176
186
177
187
## Deprecating class properties
178
188
When a class property is deprecated a few steps have to be done:
179
-
1. Add deprecation warning message by decorating the property with `@DeprecateProperty` decorator from `deprecateDecorators.ts` file.
189
+
1. Add the `@deprecated` tag at the begging of the property description followed by the version in which the property has been deprecated and what can be used instead.
180
190
2. Ensure that the deprecated property is no longer used in IgniteUI for Angular codebase, samples and documentation snippets.
181
191
3. Write migrations.
182
192
183
-
NOTE: TypeScript disallows decorating both the get and set accessor for a single member. Instead, all decorators for the member must be applied to the first accessor specified in document order. This is because decorators apply to a Property Descriptor, which combines both the get and set accessor, not each declaration separately.
193
+
NOTE: TypeScript disallows adding descriptions to both the get and set accessor for a single member. Instead, the description for the member must be applied to the first accessor specified in document order. Having this in mind the `@deprecated` tag is applied only once.
184
194
185
195
# Testing a PR
186
196
In order to test a pull request that is awaiting test, perform the following actions.
Copy file name to clipboardExpand all lines: CHANGELOG.md
+57-6Lines changed: 57 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -20,6 +20,28 @@ All notable changes for each version of this project will be documented in this
20
20
21
21
- For more information, check out the [README](https://github.com/IgniteUI/igniteui-angular/blob/master/projects/igniteui-angular/src/lib/stepper/README.md), [specification](https://github.com/IgniteUI/igniteui-angular/wiki/Stepper-Specification) and [official documentation](https://www.infragistics.com/products/ignite-ui-angular/angular/components/stepper).
22
22
23
+
- Added `IgxFocusTrap` directive, which traps the Tab key focus within an element.
- The `igx-simple-combo` which is a modification of the `igx-combo` component that allows single selection and has the appropriate UI and behavior for that. It inherits most of the `igx-combo`'s API.
35
+
- Allows the selection of single items in a filterable list.
36
+
- Supports custom values, keyboard navigation, validation, customized positioning of the item list via overlay settings.
@@ -31,9 +53,18 @@ All notable changes for each version of this project will be documented in this
31
53
- `dragLeave`
32
54
- `dragDrop`
33
55
- `dragOver`
56
+
- `IgxGrid`, `IgxTreeGrid`, `IgxHierarchicalGrid`
57
+
- Added new directives for re-templating header sorting indicators - `IgxSortHeaderIconDirective`, `IgxSortAscendingHeaderIconDirective` and `IgxSortDescendingHeaderIconDirective`.
58
+
- `IgxDialog`
59
+
- Added `focusTrap` input to set whether the Tab key focus is trapped within the dialog when opened. Defaults to `true`.
- `web-animations-js` is removed as Peer Dependency.
65
+
- Removed IE from `.browserslistrc`
66
+
- Removed IE related `polyfills`, like Importing ES7 polyfill for Object (`'core-js/es7/object'`) for IE is no longer used.
67
+
37
68
- `IgxDialog`
38
69
- **Breaking Change** - The default positionSettings open/close animation has been changed to `fadeIn`/`fadeOut`. The open/close animation can be set through the position settings, e.g. change the animation to the previously default open/close animation:
39
70
@@ -52,11 +83,31 @@ All notable changes for each version of this project will be documented in this
Use `IgxGridToolbarComponent`, `IgxGridToolbarHidingComponent`, `IgxGridToolbarPinningComponent` instead.
55
-
- `igxGrid`
86
+
- **Breaking Change** - The `rowSelected` event is renamed to `rowSelectionChanging` to better reflect its function.
87
+
- **Breaking Change** - The `columnSelected` event is renamed to `columnSelectionChanging` to better reflect its function.
88
+
- **Breaking Change** - `columnsCollection` is removed. Use `columns` instead. If at certain ocasions `columns` return empty array, query the columns using `ViewChildren` and access those in `ngAfterViewInit`:
- **Breaking Change** - `rowData` and `rowID` deprecated properties are now removed. Use `data` and `key` instead. Use `ng update` for automatic migration.
95
+
- `igxRowSelector`
96
+
- `rowID` in the context object of the `igxRowSelector` is now deprecated and will be removed in future version. Use `key` property instead:
- **Breaking Change** - Input `columns` has been removed. Use `igxGrid` `columns` input instead.
109
+
- `igxGrid`
56
110
- Exposed a `groupStrategy` input that functions similarly to `sortStrategy`, allowing customization of the grouping behavior of the grid. Please, refer to the [Group By ](https://www.infragistics.com/products/ignite-ui-angular/angular/components/grid/groupby) topic for more information.
57
-
- `IgxColumnActionsComponent`
58
-
- **Breaking Change** - The following input has been removed
59
-
- Input `columns`. Use `igxGrid` `columns` input instead.
60
111
- `IgxCarousel`
61
112
- **Breaking Changes** -The carousel animation type `CarouselAnimationType` is renamed to `HorizontalAnimationType`.
62
113
@@ -65,7 +116,7 @@ All notable changes for each version of this project will be documented in this
65
116
### General
66
117
- **Breaking Change** - `IgxPercentSummaryOperand` and `IgxCurrencySummaryOperand` have been removed and `IgxNumberSummaryOperand` should be used instead. If you have used the percent or currency summary operands to extend a custom summary operand from them, then change the custom operand to extend from the number summary operand.
67
118
- `IgxToastComponent`
68
-
- **Deprecated** - The `position` input property has been deprecated. Use `positionSettings` input instead.
119
+
- **Deprecated** - The `position` input property has been deprecated. Use `positionSettings` input instead.
69
120
## 12.2.1
70
121
71
122
### New Features
@@ -3690,4 +3741,4 @@ export class IgxCustomFilteringOperand extends IgxFilteringOperand {
3690
3741
- `IgxDraggableDirective` moved inside `../directives/dragdrop/` folder
3691
3742
- `IgxRippleDirective` moved inside `../directives/ripple/` folder
3692
3743
- Folder `"./navigation/nav-service"` renamed to `"./navigation/nav.service"`
0 commit comments