Skip to content

Add option to provide callback function to iModel action disable prop #197

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
arome merged 3 commits into from
Feb 4, 2026
+30 −5
Merged

Add option to provide callback function to iModel action disable prop #197

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
4cbada7
Enhance context menu options: add disabled state
arome Feb 4, 2026
f3df4e1
Add option to provide callback function for iModel action disable prop
arome Feb 4, 2026
c86a1e2
Merge branch 'main' into omar/disable-imodel-action-callback
arome Feb 4, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions ...ges/@itwin/imodel-browser-react/omar-disable-imodel-action-callback_2026-02-04-21-29.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
{
"changes": [
{
"packageName": "@itwin/imodel-browser-react",
"comment": "Add option to provide callback function to iModel action disable prop",
"type": "minor"
}
],
"packageName": "@itwin/imodel-browser-react"
}
19 changes: 16 additions & 3 deletions packages/apps/storybook/src/imodel-browser/IModelGrid.stories.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -213,19 +213,32 @@ IndividualContextMenu.args = {
children: "displayName contains 'R'",
visible: (iModel) => iModel.displayName?.includes("R") ?? false,
key: "withR",
onClick: (iModel) => alert("Contains R" + iModel?.displayName),
onClick: (iModel) => alert("Contains R: " + iModel?.displayName),
},
{
children: "Add description",
visible: (iModel) => !iModel.description,
key: "addD",
onClick: (iModel) => alert("Add description" + iModel?.displayName),
onClick: (iModel) => alert("Add description: " + iModel?.displayName),
},
{
children: "Edit description",
visible: (iModel) => !!iModel.description,
key: "editD",
onClick: (iModel) => alert("Edit description" + iModel?.displayName),
onClick: (iModel) => alert("Edit description: " + iModel?.displayName),
},
],
};

export const DisabledContextMenu = Template.bind({});
DisabledContextMenu.args = {
apiOverrides: { serverEnvironmentPrefix: "qa" },
iModelActions: [
{
children: "Disabled if name contains 'T'",
disabled: (iModel) => iModel.displayName?.includes("T") ?? false,
key: "withT",
onClick: (iModel) => alert("Does not contain T: " + iModel?.displayName),
},
],
};
Expand Down
6 changes: 4 additions & 2 deletions packages/modules/imodel-browser/src/utils/_buildMenuOptions.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,11 @@ import React from "react";
type MenuItemProps = React.ComponentPropsWithoutRef<typeof MenuItem>;

export interface ContextMenuBuilderItem<T = any>
extends Omit<MenuItemProps, "onClick" | "value"> {
extends Omit<MenuItemProps, "onClick" | "value" | "disabled"> {
key: string;
visible?: boolean | ((value: T) => boolean);
onClick?: ((value?: T, refetchData?: () => void) => void) | undefined;
disabled?: MenuItemProps["disabled"] | ((value: T) => boolean);
}

/** Build MenuItem array for the value for each provided options
Expand All @@ -27,10 +28,11 @@ export const _buildManagedContextMenuOptions: <T>(
?.filter?.(({ visible }) => {
return typeof visible === "function" ? visible(value) : visible ?? true;
})
.map(({ key, visible, onClick, ...contextMenuProps }) => {
.map(({ key, visible, onClick, disabled, ...contextMenuProps }) => {
return (
<MenuItem
{...contextMenuProps}
disabled={typeof disabled === "function" ? disabled(value) : disabled}
onClick={(e?: React.MouseEvent) => {
e?.stopPropagation();
closeMenu?.();
Expand Down