AG-10486 Contextmenu callback type-safety and docs #1614
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
olegat
requested review from
alantreadway,
rmc-software and
a team
as code owners
olegat
force-pushed
the
AG-10486/contextmenu_typesafetly_and_docs
branch
2 times, most recently
from
cc0d975
to
546335e
Compare
packages/ag-charts-community/src/chart/interaction/contextMenuRegistry.ts
Outdated
Show resolved
Hide resolved
lsjroberts
reviewed
May 29, 2024
| @@ -33,17 +32,17 @@ export class ContextMenu extends _ModuleSupport.BaseModuleInstance implements _M | |||
| /** | |||
| * Extra menu actions with a label and callback. | |||
| */ | |||
| public extraActions: Array<ContextMenuAction> = []; | |||
| public extraActions: NonNullable<AgContextMenuOptions['extraActions']> = []; | |||
There was a problem hiding this comment.
nit: I think we're generally trying to separate options types and modules/features types, even if it produces a bit of duplication?
There was a problem hiding this comment.
Correct.
We still do this: The internal state is stored in ContextMenu.groups, whereas ContextMenu.extraActions stores the input user options.
The ContextMenu.groups property contains some duplicated values like label and action, but it also contains internal meta-data like id? and type:
The legend context menu callbacks were apparently being called with the incorrection parameter type. This change solves that and enforces type- safely when invoking context menu callback.
Note: This is a breaking change because the event.type string in the option contract is changing.
This fixes extraNodeActions and extraLegendItemActions.
olegat
force-pushed
the
AG-10486/contextmenu_typesafetly_and_docs
branch
from
546335e
to
b297274
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
https://ag-grid.atlassian.net/browse/AG-10486