Skip to content

Commit 21cec53

Browse files
committed
refactor: mark slide/step toggleAnimation methods internal and deprecated
1 parent a048df5 commit 21cec53

File tree

7 files changed

+21
-11
lines changed

7 files changed

+21
-11
lines changed

CHANGELOG.md

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -10,12 +10,14 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
1010
- Exposed more public API type aliases for component property types like `ButtonVariant`, `PickerMode`, `StepperOrientation`, `HorizontalTransitionAnimation` (carousel and horizontal stepper) and more.
1111

1212
### Deprecated
13-
Some event argument types have been renamed for consistency:
14-
- `CheckboxChangeEventArgs` deprecated, use `IgcCheckboxChangeEventArgs` instead.
15-
- `RadioChangeEventArgs` deprecated, use `IgcRadioChangeEventArgs` instead.
16-
- `IgcRangeSliderValue` deprecated, use `IgcRangeSliderValueEventArgs` instead.
17-
- `IgcActiveStepChangingArgs` deprecated, use `IgcActiveStepChangingEventArgs` instead.
18-
- `IgcActiveStepChangedArgs` deprecated, use `IgcActiveStepChangedEventArgs` instead.
13+
- Some event argument types have been renamed for consistency:
14+
- `CheckboxChangeEventArgs` deprecated, use `IgcCheckboxChangeEventArgs` instead.
15+
- `RadioChangeEventArgs` deprecated, use `IgcRadioChangeEventArgs` instead.
16+
- `IgcRangeSliderValue` deprecated, use `IgcRangeSliderValueEventArgs` instead.
17+
- `IgcActiveStepChangingArgs` deprecated, use `IgcActiveStepChangingEventArgs` instead.
18+
- `IgcActiveStepChangedArgs` deprecated, use `IgcActiveStepChangedEventArgs` instead.
19+
- Carousel Slide's `toggleAnimation` is now marked internal and deprecated for use in favor of parent Carousel's `select` method.
20+
- Stepper Step's `toggleAnimation` is now marked internal and deprecated for use in favor of parent Stepper's `navigateTo` method.
1921

2022
### Fixed
2123
- 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)

src/components/carousel/carousel-slide.ts

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -69,6 +69,10 @@ export default class IgcCarouselSlideComponent extends LitElement {
6969
@property({ type: Boolean, reflect: true })
7070
public previous = false;
7171

72+
/**
73+
* @hidden @internal
74+
* @deprecated since 5.4.0. Use Carousel's `select` method instead.
75+
*/
7276
public async toggleAnimation(
7377
type: 'in' | 'out',
7478
direction: 'normal' | 'reverse' = 'normal'

src/components/checkbox/checkbox-base.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ export interface IgcCheckboxChangeEventArgs {
2020
value?: string;
2121
}
2222

23-
/** @deprecated use IgcCheckboxChangeEventArgs instead */
23+
/** @deprecated since 5.4.0. Use IgcCheckboxChangeEventArgs instead */
2424
export type CheckboxChangeEventArgs = IgcCheckboxChangeEventArgs;
2525

2626
export interface IgcCheckboxComponentEventMap {

src/components/radio/radio.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ export interface IgcRadioChangeEventArgs {
4545
value?: string;
4646
}
4747

48-
/** @deprecated use IgcRadioChangeEventArgs instead */
48+
/** @deprecated since 5.4.0. Use IgcRadioChangeEventArgs instead */
4949
export type RadioChangeEventArgs = IgcRadioChangeEventArgs;
5050

5151
export interface IgcRadioComponentEventMap {

src/components/slider/range-slider.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ export interface IgcRangeSliderValueEventArgs {
1616
upper: number;
1717
}
1818

19-
/** @deprecated use IgcRangeSliderValueEventArgs instead */
19+
/** @deprecated since 5.4.0. Use IgcRangeSliderValueEventArgs instead */
2020
export type IgcRangeSliderValue = IgcRangeSliderValueEventArgs;
2121

2222
export interface IgcRangeSliderComponentEventMap {

src/components/stepper/step.ts

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -156,6 +156,10 @@ export default class IgcStepComponent extends LitElement {
156156
@property({ attribute: false })
157157
public animationDuration = 350;
158158

159+
/**
160+
* @hidden @internal
161+
* @deprecated since 5.4.0. Use the Stepper's `navigateTo` method instead.
162+
*/
159163
public async toggleAnimation(
160164
type: 'in' | 'out',
161165
direction: 'normal' | 'reverse' = 'normal'

src/components/stepper/stepper.common.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,9 @@ export interface IgcActiveStepChangedEventArgs {
77
index: number;
88
}
99

10-
/** @deprecated use IgcActiveStepChangingEventArgs instead */
10+
/** @deprecated since 5.4.0. Use IgcActiveStepChangingEventArgs instead */
1111
export type IgcActiveStepChangingArgs = IgcActiveStepChangingEventArgs;
12-
/** @deprecated use IgcActiveStepChangedEventArgs instead */
12+
/** @deprecated since 5.4.0. Use IgcActiveStepChangedEventArgs instead */
1313
export type IgcActiveStepChangedArgs = IgcActiveStepChangedEventArgs;
1414

1515
export interface IgcStepperComponentEventMap {

0 commit comments

Comments
 (0)