Skip to content

armgit / plane

Public Imported from GitHub
0

πŸ”₯πŸ”₯πŸ”₯ Open-source Jira, Linear, Monday, and ClickUp alternative. Plane is a modern project management platform to manage tasks, sprints, docs, and triage.

chore: added disabled prop to multiple select components (#4724)

Aaryan Khandelwal1c849103f98c
diff --git a/web/components/core/multiple-select/entity-select-action.tsx b/web/components/core/multiple-select/entity-select-action.tsx
index 7b9ca94096..7672928cd2 100644
--- a/web/components/core/multiple-select/entity-select-action.tsx
+++ b/web/components/core/multiple-select/entity-select-action.tsx
@@ -18,6 +18,8 @@ export const MultipleSelectEntityAction: React.FC<Props> = (props) => {
// derived values
const isSelected = selectionHelpers.getIsEntitySelected(id);
+ if (selectionHelpers.isSelectionDisabled) return null;
+
return (
<Checkbox
className={cn("!outline-none size-3.5", className)}
diff --git a/web/components/core/multiple-select/group-select-action.tsx b/web/components/core/multiple-select/group-select-action.tsx
index ae2532153a..eee771d51f 100644
--- a/web/components/core/multiple-select/group-select-action.tsx
+++ b/web/components/core/multiple-select/group-select-action.tsx
@@ -17,6 +17,8 @@ export const MultipleSelectGroupAction: React.FC<Props> = (props) => {
// derived values
const groupSelectionStatus = selectionHelpers.isGroupSelected(groupID);
+ if (selectionHelpers.isSelectionDisabled) return null;
+
return (
<Checkbox
className={cn("size-3.5 !outline-none", className)}
diff --git a/web/components/core/multiple-select/select-group.tsx b/web/components/core/multiple-select/select-group.tsx
index 6f47b06329..6110642d11 100644
--- a/web/components/core/multiple-select/select-group.tsx
+++ b/web/components/core/multiple-select/select-group.tsx
@@ -5,14 +5,16 @@ import { TSelectionHelper, useMultipleSelect } from "@/hooks/use-multiple-select
type Props = {
children: (helpers: TSelectionHelper) => React.ReactNode;
containerRef: React.MutableRefObject<HTMLElement | null>;
+ disabled?: boolean;
entities: Record<string, string[]>; // { groupID: entityIds[] }
};
export const MultipleSelectGroup: React.FC<Props> = observer((props) => {
- const { children, containerRef, entities } = props;
+ const { children, containerRef, disabled = false, entities } = props;
const helpers = useMultipleSelect({
containerRef,
+ disabled,
entities,
});
diff --git a/web/components/gantt-chart/chart/main-content.tsx b/web/components/gantt-chart/chart/main-content.tsx
index e5bd7afbfb..fc62f1bbce 100644
--- a/web/components/gantt-chart/chart/main-content.tsx
+++ b/web/components/gantt-chart/chart/main-content.tsx
@@ -118,6 +118,7 @@ export const GanttChartMainContent: React.FC<Props> = observer((props) => {
entities={{
[GANTT_SELECT_GROUP]: chartBlocks?.map((block) => block.id) ?? [],
}}
+ disabled
>
{(helpers) => (
<>
diff --git a/web/components/issues/bulk-operations/root.tsx b/web/components/issues/bulk-operations/root.tsx
index f92e022796..741a341bec 100644
--- a/web/components/issues/bulk-operations/root.tsx
+++ b/web/components/issues/bulk-operations/root.tsx
@@ -11,11 +11,11 @@ type Props = {
};
export const IssueBulkOperationsRoot: React.FC<Props> = observer((props) => {
- const { className } = props;
+ const { className, selectionHelpers } = props;
// store hooks
const { isSelectionActive } = useMultipleSelectStore();
- if (!isSelectionActive) return null;
+ if (!isSelectionActive || selectionHelpers.isSelectionDisabled) return null;
return <BulkOperationsUpgradeBanner className={className} />;
});
diff --git a/web/components/issues/issue-layouts/gantt/base-gantt-root.tsx b/web/components/issues/issue-layouts/gantt/base-gantt-root.tsx
index 17df47163f..2f257c6cd7 100644
--- a/web/components/issues/issue-layouts/gantt/base-gantt-root.tsx
+++ b/web/components/issues/issue-layouts/gantt/base-gantt-root.tsx
@@ -72,7 +72,7 @@ export const BaseGanttRoot: React.FC<IBaseGanttRoot> = observer((props: IBaseGan
enableBlockMove={isAllowed}
enableReorder={appliedDisplayFilters?.order_by === "sort_order" && isAllowed}
enableAddBlock={isAllowed}
- enableSelection={isAllowed}
+ enableSelection={false}
quickAdd={
enableIssueCreation && isAllowed ? (
<GanttQuickAddIssueForm quickAddCallback={issues.quickAddIssue} viewId={viewId} />
diff --git a/web/components/issues/issue-layouts/list/block.tsx b/web/components/issues/issue-layouts/list/block.tsx
index 42f7afff68..dabcf3a240 100644
--- a/web/components/issues/issue-layouts/list/block.tsx
+++ b/web/components/issues/issue-layouts/list/block.tsx
@@ -102,6 +102,7 @@ export const IssueBlock = observer((props: IssueBlockProps) => {
const isIssueSelected = selectionHelpers.getIsEntitySelected(issue.id);
const isIssueActive = selectionHelpers.getIsEntityActive(issue.id);
const isSubIssue = nestingLevel !== 0;
+ const canSelectIssues = canEditIssueProperties && !selectionHelpers.isSelectionDisabled;
const marginLeft = `${spacingLeft}px`;
@@ -149,7 +150,7 @@ export const IssueBlock = observer((props: IssueBlockProps) => {
<div className="flex flex-grow items-center gap-0.5 truncate">
<div className="flex items-center gap-1" style={isSubIssue ? { marginLeft } : {}}>
{/* select checkbox */}
- {projectId && canEditIssueProperties && (
+ {projectId && canSelectIssues && (
<Tooltip
tooltipContent={
<>
diff --git a/web/components/issues/issue-layouts/list/default.tsx b/web/components/issues/issue-layouts/list/default.tsx
index daddc572f3..321f0640f8 100644
--- a/web/components/issues/issue-layouts/list/default.tsx
+++ b/web/components/issues/issue-layouts/list/default.tsx
@@ -134,7 +134,7 @@ const GroupByList: React.FC<IGroupByList> = observer((props) => {
return (
<div className="relative size-full flex flex-col">
{groups && (
- <MultipleSelectGroup containerRef={containerRef} entities={entities}>
+ <MultipleSelectGroup containerRef={containerRef} entities={entities} disabled>
{(helpers) => (
<>
<div
diff --git a/web/components/issues/issue-layouts/list/headers/group-by-card.tsx b/web/components/issues/issue-layouts/list/headers/group-by-card.tsx
index cfda916137..23253b55f3 100644
--- a/web/components/issues/issue-layouts/list/headers/group-by-card.tsx
+++ b/web/components/issues/issue-layouts/list/headers/group-by-card.tsx
@@ -57,7 +57,7 @@ export const HeaderGroupByCard = observer((props: IHeaderGroupByCard) => {
const existingIssuesListModalPayload = moduleId ? { module: moduleId.toString() } : { cycle: true };
const isGroupSelectionEmpty = selectionHelpers.isGroupSelected(groupID) === "empty";
// auth
- const canSelectIssues = canEditProperties(projectId?.toString());
+ const canSelectIssues = canEditProperties(projectId?.toString()) && !selectionHelpers.isSelectionDisabled;
const handleAddIssuesToView = async (data: ISearchIssueResponse[]) => {
if (!workspaceSlug || !projectId) return;
@@ -83,7 +83,7 @@ export const HeaderGroupByCard = observer((props: IHeaderGroupByCard) => {
return (
<>
- <div className="group/list-header relative w-full flex-shrink-0 flex items-center gap-2 py-1.5">
+ <div className="group/list-header relative w-full flex-shrink-0 flex items-center gap-2 py-1.5 pl-1">
{canSelectIssues && (
<div className="flex-shrink-0 flex items-center w-3.5">
<MultipleSelectGroupAction
diff --git a/web/components/issues/issue-layouts/spreadsheet/issue-row.tsx b/web/components/issues/issue-layouts/spreadsheet/issue-row.tsx
index 0cb36969e7..d80a4bfdc1 100644
--- a/web/components/issues/issue-layouts/spreadsheet/issue-row.tsx
+++ b/web/components/issues/issue-layouts/spreadsheet/issue-row.tsx
@@ -222,6 +222,8 @@ const IssueRowDetails = observer((props: IssueRowDetailsProps) => {
const subIssuesCount = issueDetail?.sub_issues_count ?? 0;
const isIssueSelected = selectionHelpers.getIsEntitySelected(issueDetail.id);
+ const canSelectIssues = !disableUserActions && !selectionHelpers.isSelectionDisabled;
+
//TODO: add better logic. This is to have a min width for ID/Key based on the length of project identifier
const keyMinWidth = (getProjectIdentifierById(issueDetail.project_id)?.length ?? 0 + 5) * 7;
@@ -250,7 +252,7 @@ const IssueRowDetails = observer((props: IssueRowDetailsProps) => {
>
<div className="flex items-center gap-0.5 min-w-min py-2.5 pl-2">
{/* select checkbox */}
- {projectId && !disableUserActions && (
+ {projectId && canSelectIssues && (
<Tooltip
tooltipContent={
<>
diff --git a/web/components/issues/issue-layouts/spreadsheet/spreadsheet-header.tsx b/web/components/issues/issue-layouts/spreadsheet/spreadsheet-header.tsx
index 74f65db317..6052454d1b 100644
--- a/web/components/issues/issue-layouts/spreadsheet/spreadsheet-header.tsx
+++ b/web/components/issues/issue-layouts/spreadsheet/spreadsheet-header.tsx
@@ -38,7 +38,7 @@ export const SpreadsheetHeader = observer((props: Props) => {
// derived values
const isGroupSelectionEmpty = selectionHelpers.isGroupSelected(SPREADSHEET_SELECT_GROUP) === "empty";
// auth
- const canSelectIssues = canEditProperties(projectId?.toString());
+ const canSelectIssues = canEditProperties(projectId?.toString()) && !selectionHelpers.isSelectionDisabled;
return (
<thead className="sticky top-0 left-0 z-[12] border-b-[0.5px] border-custom-border-100">
diff --git a/web/components/issues/issue-layouts/spreadsheet/spreadsheet-view.tsx b/web/components/issues/issue-layouts/spreadsheet/spreadsheet-view.tsx
index 8287ea7460..169d4f94cf 100644
--- a/web/components/issues/issue-layouts/spreadsheet/spreadsheet-view.tsx
+++ b/web/components/issues/issue-layouts/spreadsheet/spreadsheet-view.tsx
@@ -81,6 +81,7 @@ export const SpreadsheetView: React.FC<Props> = observer((props) => {
entities={{
[SPREADSHEET_SELECT_GROUP]: issueIds,
}}
+ disabled
>
{(helpers) => (
<>
diff --git a/web/hooks/use-multiple-select.ts b/web/hooks/use-multiple-select.ts
index 47f6736242..fdb3c0b1c1 100644
--- a/web/hooks/use-multiple-select.ts
+++ b/web/hooks/use-multiple-select.ts
@@ -10,6 +10,7 @@ export type TEntityDetails = {
type Props = {
containerRef: React.MutableRefObject<HTMLElement | null>;
+ disabled: boolean;
entities: Record<string, string[]>; // { groupID: entityIds[] }
};
@@ -25,10 +26,11 @@ export type TSelectionHelper = {
getIsEntityActive: (entityID: string) => boolean;
handleGroupClick: (groupID: string) => void;
isGroupSelected: (groupID: string) => "empty" | "partial" | "complete";
+ isSelectionDisabled: boolean;
};
export const useMultipleSelect = (props: Props) => {
- const { containerRef, entities } = props;
+ const { containerRef, disabled, entities } = props;
// router
const router = useRouter();
// store hooks
@@ -97,6 +99,8 @@ export const useMultipleSelect = (props: Props) => {
const handleActiveEntityChange = useCallback(
(entityDetails: TEntityDetails | null, shouldScroll: boolean = true) => {
+ if (disabled) return;
+
if (!entityDetails) {
updateActiveEntityDetails(null);
updatePreviousActiveEntity(null);
@@ -134,6 +138,7 @@ export const useMultipleSelect = (props: Props) => {
},
[
containerRef,
+ disabled,
getPreviousAndNextEntities,
updateActiveEntityDetails,
updateNextActiveEntity,
@@ -147,6 +152,8 @@ export const useMultipleSelect = (props: Props) => {
shouldScroll: boolean = true,
forceAction: "force-add" | "force-remove" | null = null
) => {
+ if (disabled) return;
+
if (Array.isArray(entityDetails)) {
bulkUpdateSelectedEntityDetails(entityDetails, forceAction === "force-add" ? "add" : "remove");
if (forceAction === "force-add" && entityDetails.length > 0) {
@@ -176,7 +183,13 @@ export const useMultipleSelect = (props: Props) => {
handleActiveEntityChange(entityDetails, shouldScroll);
}
},
- [bulkUpdateSelectedEntityDetails, getIsEntitySelected, handleActiveEntityChange, updateSelectedEntityDetails]
+ [
+ bulkUpdateSelectedEntityDetails,
+ disabled,
+ getIsEntitySelected,
+ handleActiveEntityChange,
+ updateSelectedEntityDetails,
+ ]
);
/**
@@ -187,6 +200,7 @@ export const useMultipleSelect = (props: Props) => {
*/
const handleEntityClick = useCallback(
(e: React.MouseEvent, entityID: string, groupID: string) => {
+ if (disabled) return;
const lastSelectedEntityDetails = getLastSelectedEntityDetails();
if (e.shiftKey && lastSelectedEntityDetails) {
const currentEntityIndex = entitiesList.findIndex((entity) => entity?.entityID === entityID);
@@ -223,7 +237,7 @@ export const useMultipleSelect = (props: Props) => {
handleEntitySelection({ entityID, groupID }, false);
},
- [entitiesList, handleEntitySelection, getLastSelectedEntityDetails]
+ [disabled, entitiesList, handleEntitySelection, getLastSelectedEntityDetails]
);
/**
@@ -248,15 +262,19 @@ export const useMultipleSelect = (props: Props) => {
*/
const handleGroupClick = useCallback(
(groupID: string) => {
+ if (disabled) return;
+
const groupEntities = entitiesList.filter((entity) => entity.groupID === groupID);
const groupSelectionStatus = isGroupSelected(groupID);
handleEntitySelection(groupEntities, false, groupSelectionStatus === "empty" ? "force-add" : "force-remove");
},
- [entitiesList, handleEntitySelection, isGroupSelected]
+ [disabled, entitiesList, handleEntitySelection, isGroupSelected]
);
// clear selection on escape key press
useEffect(() => {
+ if (disabled) return;
+
const handleKeyDown = (e: KeyboardEvent) => {
if (e.key === "Escape") clearSelection();
};
@@ -265,10 +283,12 @@ export const useMultipleSelect = (props: Props) => {
return () => {
window.removeEventListener("keydown", handleKeyDown);
};
- }, [clearSelection]);
+ }, [clearSelection, disabled]);
// select entities on shift + arrow up/down key press
useEffect(() => {
+ if (disabled) return;
+
const handleKeyDown = (e: KeyboardEvent) => {
if (!e.shiftKey) return;
@@ -291,6 +311,7 @@ export const useMultipleSelect = (props: Props) => {
window.removeEventListener("keydown", handleKeyDown);
};
}, [
+ disabled,
getActiveEntityDetails,
handleEntitySelection,
getLastSelectedEntityDetails,
@@ -299,6 +320,8 @@ export const useMultipleSelect = (props: Props) => {
]);
useEffect(() => {
+ if (disabled) return;
+
const handleKeyDown = (e: KeyboardEvent) => {
if (e.shiftKey) return;
const activeEntityDetails = getActiveEntityDetails();
@@ -331,7 +354,7 @@ export const useMultipleSelect = (props: Props) => {
return () => {
window.removeEventListener("keydown", handleKeyDown);
};
- }, [getActiveEntityDetails, entitiesList, groups, getPreviousAndNextEntities, handleActiveEntityChange]);
+ }, [disabled, getActiveEntityDetails, entitiesList, groups, getPreviousAndNextEntities, handleActiveEntityChange]);
// clear selection on route change
useEffect(() => {
@@ -346,6 +369,7 @@ export const useMultipleSelect = (props: Props) => {
// when entities list change, remove entityIds from the selected entities array, which are not present in the new list
useEffect(() => {
+ if (disabled) return;
selectedEntityIds.map((entityID) => {
const isEntityPresent = entitiesList.find((en) => en.entityID === entityID);
if (!isEntityPresent) {
@@ -355,7 +379,7 @@ export const useMultipleSelect = (props: Props) => {
}
}
});
- }, [entitiesList, getEntityDetailsFromEntityID, handleEntitySelection, selectedEntityIds]);
+ }, [disabled, entitiesList, getEntityDetailsFromEntityID, handleEntitySelection, selectedEntityIds]);
/**
* @description helper functions for selection
@@ -368,8 +392,17 @@ export const useMultipleSelect = (props: Props) => {
getIsEntityActive,
handleGroupClick,
isGroupSelected,
+ isSelectionDisabled: disabled,
}),
- [clearSelection, getIsEntityActive, getIsEntitySelected, handleEntityClick, handleGroupClick, isGroupSelected]
+ [
+ clearSelection,
+ disabled,
+ getIsEntityActive,
+ getIsEntitySelected,
+ handleEntityClick,
+ handleGroupClick,
+ isGroupSelected,
+ ]
);
return helpers;