Igniteui-angular: Intruduce missing "ing" or "ed" events for grid features.

Created on 12 Jan 2021  Β·  4Comments  Β·  Source: IgniteUI/igniteui-angular

Currently some features introduce only "ing" events, like onColumnPinning, others introduce only "ed" events, like onColumnResized. Also, different naming convetion is used in event names and in interfaces.

First table below shows current situation, next table shows implementation plan.

⚠ Behavioral changes
πŸ†• New stuff
❌ Missing

Β  | Ing event | Ed event
-- | -- | --
Sorting | ❌ | onSortingDone
Filtering | ❌ | onFilteringDone
Paging | onPagingDone | ❌
Pinning | onColumnPinning | ❌
Hiding | ❌ | onColumnVisibilityChanged
Resizing | ❌ | onColumnResized
Moving | onColumnMovingStart, onColumnMoving | onColumnMovingEnd

Missing events need to be introduced. Also, try to unify naming convention and interfaces (in terms of structure and naming) as much as possible, with as less as possible breaking or behavioral changes. See table below for what will be implemented.

Π•vent | Interface
-- | --
sorting πŸ†• | ISortingEventArgs πŸ†•
filtering πŸ†• | IFilteringEventArgs πŸ†•
onPaging πŸ†• | IPagingEventArgsπŸ†•
onColumnPinning ⚠ | IPinColumnCancellableEventArgs πŸ†•
columnVisibilityChanging πŸ†• | IColumnVisibilityChangingEventArgs πŸ†•
columnResizing πŸ†• | IColumnResizingEventArgs πŸ†•
onColumnMovingStart | IColumnMovingStartEventArgs
onColumnMoving | IColumnMovingEventArgs
| Β 
onSortingDone | ISortingExpression \| Array
onFilteringDone | IFilteringExpressionsTree
onPagingDone ⚠ | IPageEventArgs
columnPinned πŸ†• | IPinColumnEventArgs
onColumnVisibilityChanged | IColumnVisibilityChangedEventArgs
onColumnResized | IColumnResizeEventArgs
onColumnMovingEnd | IColumnMovingEndEventArgs

πŸ“ Notes:

  • All '-ing' events interfaces will extend IBaseEventArgs and CancelableEventArgs

⚠ Behavioral changes:

  • pageChange is now hidden, and exposes a message to use onPagingDone instead.
  • onPagingDone will be emitted AFTER the operation has completed
  • onColumnPinning to emit IPinColumnCancellableEventArgs, instead of IPinColumnEventArgs. isPinned in both "ing" and "ed" events will contain the current pin state of the column.

NOTE: Paging related stuff will be implemented with #8923

enhancement feature-request general resolved

Most helpful comment

At least we can try not exposing the proposed events with that prefix though?

@rkaraivanov suggested the same - new events will skip "on" prefixing. Old events will be renamed later with a mass migration that will happen. I updated the tables accordingly.

All 4 comments

@hanastasov @rkaraivanov Can we consider removing all 'on' prefixes of the newly exposed and currently existing events as it was discussed some time ago?

@hanastasov @rkaraivanov Can we consider removing all 'on' prefixes of the newly exposed and currently existing events as it was discussed some time ago?

I thought about it, but didn't find it stated official somewhere. It will be a lot of changes, but we need to do it eventually.

At least we can try not exposing the proposed events with that prefix though?

At least we can try not exposing the proposed events with that prefix though?

@rkaraivanov suggested the same - new events will skip "on" prefixing. Old events will be renamed later with a mass migration that will happen. I updated the tables accordingly.

Was this page helpful?
0 / 5 - 0 ratings