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
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
+31-3Lines changed: 31 additions & 3 deletions
Original file line number
Diff line number
Diff line change
@@ -20,12 +20,38 @@ 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.
- Exposed new input `buttonText` which sets the text that is displayed inside the dropdown button in the toolbar.
27
49
- `IgxCombo`
28
50
- Added `groupSortingDirection` input, which allows you to set groups sorting order.
51
+
- `IgxGrid`, `IgxTreeGrid`, `IgxHierarchicalGrid`
52
+
- Added new directives for re-templating header sorting indicators - `IgxSortHeaderIconDirective`, `IgxSortAscendingHeaderIconDirective` and `IgxSortDescendingHeaderIconDirective`.
53
+
- `IgxDialog`
54
+
- Added `focusTrap` input to set whether the Tab key focus is trapped within the dialog when opened. Defaults to `true`.
29
55
30
56
### General
31
57
@@ -47,19 +73,21 @@ All notable changes for each version of this project will be documented in this
Use `IgxGridToolbarComponent`, `IgxGridToolbarHidingComponent`, `IgxGridToolbarPinningComponent` instead.
76
+
- **Breaking Change** - The `rowSelected` event is renamed to `rowSelectionChanging` to better reflect its function
50
77
- `igxGrid`
51
78
- 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.
52
79
- `IgxColumnActionsComponent`
53
80
- **Breaking Change** - The following input has been removed
54
81
- Input `columns`. Use `igxGrid` `columns` input instead.
55
82
- `IgxCarousel`
56
-
- **Breaking Changes** -The carousel animation type `CarouselAnimationType` is renamed to `HorizontalAnimationType`.
83
+
- **Breaking Changes** -The carousel animation type `CarouselAnimationType` is renamed to `HorizontalAnimationType`.
57
84
58
85
## 12.2.3
59
86
60
87
### General
61
88
- **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.
62
-
89
+
- `IgxToastComponent`
90
+
- **Deprecated** - The `position` input property has been deprecated. Use `positionSettings` input instead.
63
91
## 12.2.1
64
92
65
93
### New Features
@@ -3684,4 +3712,4 @@ export class IgxCustomFilteringOperand extends IgxFilteringOperand {
3684
3712
- `IgxDraggableDirective` moved inside `../directives/dragdrop/` folder
3685
3713
- `IgxRippleDirective` moved inside `../directives/ripple/` folder
3686
3714
- Folder `"./navigation/nav-service"` renamed to `"./navigation/nav.service"`
0 commit comments