Skip to content

Commit 794f969

Browse files
committed
refactor: unify event args naming
1 parent 88b1e7b commit 794f969

File tree

6 files changed

+47
-16
lines changed

6 files changed

+47
-16
lines changed

CHANGELOG.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,14 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
88
### Added
99
- New File Input Component(`igc-file-input`)
1010

11+
### Deprecated
12+
Some event argument types have been renamed for consistency:
13+
- `CheckboxChangeEventArgs` deprecated, use `IgcCheckboxChangeEventArgs` instead.
14+
- `RadioChangeEventArgs` deprecated, use `IgcRadioChangeEventArgs` instead.
15+
- `IgcRangeSliderValue` deprecated, use `IgcRangeSliderValueEventArgs` instead.
16+
- `IgcActiveStepChangingArgs` deprecated, use `IgcActiveStepChangingEventArgs` instead.
17+
- `IgcActiveStepChangedArgs` deprecated, use `IgcActiveStepChangedEventArgs` instead.
18+
1119
### Fixed
1220
- Setting validation properties on a pristine non-dirty form associated element does not apply invalid styles [#1632](https://github.com/IgniteUI/igniteui-webcomponents/issues/1632)
1321
- Exposed `IgcCalendarResourceStrings`, `PopoverPlacement` (Dropdown and Select) and `IgcTreeSelectionEventArgs` from the public API

src/components/checkbox/checkbox-base.ts

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,13 +14,16 @@ import {
1414
import { isEmpty } from '../common/util.js';
1515
import { checkBoxValidators } from './validators.js';
1616

17-
export interface CheckboxChangeEventArgs {
17+
export interface IgcCheckboxChangeEventArgs {
1818
checked: boolean;
1919
value?: string;
2020
}
2121

22+
/** @deprecated use IgcCheckboxChangeEventArgs instead */
23+
export type CheckboxChangeEventArgs = IgcCheckboxChangeEventArgs;
24+
2225
export interface IgcCheckboxComponentEventMap {
23-
igcChange: CustomEvent<CheckboxChangeEventArgs>;
26+
igcChange: CustomEvent<IgcCheckboxChangeEventArgs>;
2427
// For analyzer meta only:
2528
/* skipWCPrefix */
2629
focus: FocusEvent;

src/components/radio/radio.ts

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -39,13 +39,16 @@ import { all } from './themes/themes.js';
3939
import { getGroup } from './utils.js';
4040
import { radioValidators } from './validators.js';
4141

42-
export interface RadioChangeEventArgs {
42+
export interface IgcRadioChangeEventArgs {
4343
checked: boolean;
4444
value?: string;
4545
}
4646

47+
/** @deprecated use IgcRadioChangeEventArgs instead */
48+
export type RadioChangeEventArgs = IgcRadioChangeEventArgs;
49+
4750
export interface IgcRadioComponentEventMap {
48-
igcChange: CustomEvent<RadioChangeEventArgs>;
51+
igcChange: CustomEvent<IgcRadioChangeEventArgs>;
4952
// For analyzer meta only:
5053
/* skipWCPrefix */
5154
focus: FocusEvent;

src/components/slider/range-slider.ts

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,20 +11,23 @@ import { IgcSliderBaseComponent } from './slider-base.js';
1111
import IgcSliderLabelComponent from './slider-label.js';
1212

1313
/* blazorSuppress */
14-
export interface IgcRangeSliderValue {
14+
export interface IgcRangeSliderValueEventArgs {
1515
lower: number;
1616
upper: number;
1717
}
1818

19+
/** @deprecated use IgcRangeSliderValueEventArgs instead */
20+
export type IgcRangeSliderValue = IgcRangeSliderValueEventArgs;
21+
1922
export interface IgcRangeSliderComponentEventMap {
2023
/**
2124
* Emitted when a value is changed via thumb drag or keyboard interaction.
2225
*/
23-
igcInput: CustomEvent<IgcRangeSliderValue>;
26+
igcInput: CustomEvent<IgcRangeSliderValueEventArgs>;
2427
/**
2528
* Emitted when a value change is committed on a thumb drag end or keyboard interaction.
2629
*/
27-
igcChange: CustomEvent<IgcRangeSliderValue>;
30+
igcChange: CustomEvent<IgcRangeSliderValueEventArgs>;
2831
}
2932

3033
/**
Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,18 @@
1-
export interface IgcActiveStepChangingArgs {
1+
export interface IgcActiveStepChangingEventArgs {
22
oldIndex: number;
33
newIndex: number;
44
}
55

6-
export interface IgcActiveStepChangedArgs {
6+
export interface IgcActiveStepChangedEventArgs {
77
index: number;
88
}
99

10+
/** @deprecated use IgcActiveStepChangingEventArgs instead */
11+
export type IgcActiveStepChangingArgs = IgcActiveStepChangingEventArgs;
12+
/** @deprecated use IgcActiveStepChangedEventArgs instead */
13+
export type IgcActiveStepChangedArgs = IgcActiveStepChangedEventArgs;
14+
1015
export interface IgcStepperComponentEventMap {
11-
igcActiveStepChanging: CustomEvent<IgcActiveStepChangingArgs>;
12-
igcActiveStepChanged: CustomEvent<IgcActiveStepChangedArgs>;
16+
igcActiveStepChanging: CustomEvent<IgcActiveStepChangingEventArgs>;
17+
igcActiveStepChanged: CustomEvent<IgcActiveStepChangedEventArgs>;
1318
}

src/index.ts

Lines changed: 14 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -131,15 +131,15 @@ export type {
131131
WeekDays,
132132
} from './components/calendar/types.js';
133133
export { DateRangeType } from './components/calendar/types.js';
134-
export type { CheckboxChangeEventArgs } from './components/checkbox/checkbox-base.js';
134+
export type { IgcCheckboxChangeEventArgs } from './components/checkbox/checkbox-base.js';
135135
export { DatePart } from './components/date-time-input/date-util.js';
136136
export type { DatePartDeltas } from './components/date-time-input/date-util.js';
137137
export type { PopoverPlacement } from './components/popover/popover.js';
138-
export type { RadioChangeEventArgs } from './components/radio/radio.js';
139-
export type { IgcRangeSliderValue } from './components/slider/range-slider.js';
138+
export type { IgcRadioChangeEventArgs } from './components/radio/radio.js';
139+
export type { IgcRangeSliderValueEventArgs } from './components/slider/range-slider.js';
140140
export type {
141-
IgcActiveStepChangingArgs,
142-
IgcActiveStepChangedArgs,
141+
IgcActiveStepChangingEventArgs,
142+
IgcActiveStepChangedEventArgs,
143143
} from './components/stepper/stepper.common.js';
144144
export type { IgcTreeSelectionEventArgs } from './components/tree/tree.common.js';
145145
export type {
@@ -150,3 +150,12 @@ export type {
150150
IgcComboChangeEventArgs,
151151
} from './components/combo/types.js';
152152
export type { IconMeta } from './components/icon/registry/types.js';
153+
154+
// deprecated types
155+
export type { CheckboxChangeEventArgs } from './components/checkbox/checkbox-base.js';
156+
export type { RadioChangeEventArgs } from './components/radio/radio.js';
157+
export type { IgcRangeSliderValue } from './components/slider/range-slider.js';
158+
export type {
159+
IgcActiveStepChangingArgs,
160+
IgcActiveStepChangedArgs,
161+
} from './components/stepper/stepper.common.js';

0 commit comments

Comments
 (0)