refactor(splitter): event name align with rest of components (#2161)

Author: damyanpetev

src/components/splitter/splitter.spec.ts

@@ -28,7 +28,7 @@ import IgcTreeComponent from '../tree/tree.js';
 import IgcTreeItemComponent from '../tree/tree-item.js';
 import type { SplitterOrientation } from '../types.js';
 import IgcSplitterComponent, {
-  type IgcSplitterResizeEventDetail,
+  type IgcSplitterResizeEventArgs,
 } from './splitter.js';
 
 const BAR_PART = 'splitter-bar';
@@ -3074,9 +3074,9 @@ function getPanesSizes(
 
 function checkResizeEvents(
   eventSpy: sinon.SinonSpy,
-  startArgs?: IgcSplitterResizeEventDetail,
-  resizingArgs?: IgcSplitterResizeEventDetail,
-  endArgs?: IgcSplitterResizeEventDetail
+  startArgs?: IgcSplitterResizeEventArgs,
+  resizingArgs?: IgcSplitterResizeEventArgs,
+  endArgs?: IgcSplitterResizeEventArgs
 ) {
   expect(eventSpy.calledWith('igcResizeStart')).to.be.true;
   expect(eventSpy.calledWith('igcResizing')).to.be.true;

src/components/splitter/splitter.ts

@@ -35,6 +35,7 @@ import { styles } from './themes/splitter.base.css.js';
 import { all } from './themes/themes.js';
 import type {
   IgcSplitterComponentEventMap,
+  IgcSplitterResizeEventArgs,
   IgcSplitterResizeEventDetail,
   PanePosition,
   PaneResizeSnapshot,
@@ -989,7 +990,11 @@ export default class IgcSplitterComponent extends EventEmitterMixin<
   //#endregion
 }
 
-export type { IgcSplitterComponentEventMap, IgcSplitterResizeEventDetail };
+export type {
+  IgcSplitterComponentEventMap,
+  IgcSplitterResizeEventArgs,
+  IgcSplitterResizeEventDetail,
+};
 
 declare global {
   interface HTMLElementTagNameMap {

src/components/splitter/types.ts

@@ -25,7 +25,7 @@ interface SplitterResizeState {
   dragPointerId: number;
 }
 
-interface IgcSplitterResizeEventDetail {
+interface IgcSplitterResizeEventArgs {
   /** The current size of the start panel in pixels */
   startPanelSize: number;
   /** The current size of the end panel in pixels */
@@ -34,17 +34,24 @@ interface IgcSplitterResizeEventDetail {
   delta?: number;
 }
 
+/**
+ * @hidden
+ * @deprecated use IgcSplitterResizeEventArgs instead
+ */
+interface IgcSplitterResizeEventDetail extends IgcSplitterResizeEventArgs {}
+
 interface IgcSplitterComponentEventMap {
-  igcResizeStart: CustomEvent<IgcSplitterResizeEventDetail>;
-  igcResizing: CustomEvent<IgcSplitterResizeEventDetail>;
-  igcResizeEnd: CustomEvent<IgcSplitterResizeEventDetail>;
+  igcResizeStart: CustomEvent<IgcSplitterResizeEventArgs>;
+  igcResizing: CustomEvent<IgcSplitterResizeEventArgs>;
+  igcResizeEnd: CustomEvent<IgcSplitterResizeEventArgs>;
 }
 
 export type {
   PanePosition,
   SplitterPaneState,
   PaneResizeSnapshot,
   SplitterResizeState,
+  IgcSplitterResizeEventArgs,
   IgcSplitterResizeEventDetail,
   IgcSplitterComponentEventMap,
 };

src/index.ts

@@ -176,7 +176,10 @@ export type {
 export type { PopoverPlacement } from './components/popover/popover.js';
 export type { IgcRadioChangeEventArgs } from './components/radio/radio.js';
 export type { IgcRangeSliderValueEventArgs } from './components/slider/range-slider.js';
-export type { IgcSplitterResizeEventDetail } from './components/splitter/splitter.js';
+export type {
+  IgcSplitterResizeEventArgs,
+  IgcSplitterResizeEventDetail,
+} from './components/splitter/splitter.js';
 export type {
   IgcActiveStepChangingEventArgs,
   IgcActiveStepChangedEventArgs,