dev: applied filters list implementation using MobX (#2325)

* dev: applied filters list UI

* fix: filter item height

* chore: remove unnecessary classes

* fix: params generator
This commit is contained in:
Aaryan Khandelwal 2023-10-02 12:41:40 +05:30 committed by GitHub
parent 727042468a
commit 569a6c3383
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
39 changed files with 434 additions and 33 deletions

View File

@ -6,7 +6,7 @@ import useSWR from "swr";
// mobx store
import { useMobxStore } from "lib/mobx/store-provider";
// components
import { CalendarLayout, GanttLayout, KanBanLayout, SpreadsheetLayout } from "components/issues";
import { AppliedFiltersList, CalendarLayout, GanttLayout, KanBanLayout, SpreadsheetLayout } from "components/issues";
export const AllViews: React.FC = observer(() => {
const router = useRouter();
@ -34,7 +34,8 @@ export const AllViews: React.FC = observer(() => {
const activeLayout = issueFilterStore.userDisplayFilters.layout;
return (
<div className="relative w-full h-full overflow-auto">
<div className="relative w-full h-full flex flex-col overflow-auto">
<AppliedFiltersList />
{activeLayout === "kanban" ? (
<KanBanLayout />
) : activeLayout === "calendar" ? (

View File

@ -1,9 +1,9 @@
import React from "react";
// components
import { LayoutSelection } from "../issues/issue-layouts/header/layout-selection";
import { IssueDropdown } from "../issues/issue-layouts/header/helpers/dropdown";
import { FilterSelection } from "../issues/issue-layouts/header/filters/filters-selection";
import { DisplayFiltersSelection } from "../issues/issue-layouts/header/display-filters";
import { LayoutSelection } from "../issues/issue-layouts/filters/header/layout-selection";
import { IssueDropdown } from "../issues/issue-layouts/filters/header/helpers/dropdown";
import { FilterSelection } from "../issues/issue-layouts/filters/header/filters/filters-selection";
import { DisplayFiltersSelection } from "../issues/issue-layouts/filters/header/display-filters";
import { FilterPreview } from "./filters-preview";

View File

@ -96,9 +96,7 @@ export const CalendarMonthsDropdown: React.FC = observer(() => {
<button
key={month.shortTitle}
type="button"
className={`text-xs hover:bg-custom-background-80 rounded py-0.5 ${
activeMonthDate.getMonth() === index ? "bg-custom-background-80" : ""
}`}
className="text-xs hover:bg-custom-background-80 rounded py-0.5"
onClick={() => {
const newDate = new Date(activeMonthDate.getFullYear(), index, 1);
handleDateChange(newDate);

View File

@ -21,8 +21,10 @@ export const CalendarIssueBlocks: React.FC<Props> = observer((props) => {
{(provided, snapshot) => (
<Link href={`/${workspaceSlug?.toString()}/projects/${issue.project}/issues/${issue.id}`}>
<a
className={`h-8 w-full shadow-custom-shadow-2xs rounded py-1.5 px-1 flex items-center gap-1.5 border-[0.5px] border-custom-border-200 ${
snapshot.isDragging ? "shadow-custom-shadow-rg bg-custom-background-90" : "bg-custom-background-100"
className={`h-8 w-full shadow-custom-shadow-2xs rounded py-1.5 px-1 flex items-center gap-1.5 border-[0.5px] border-custom-border-100 ${
snapshot.isDragging
? "shadow-custom-shadow-rg bg-custom-background-90"
: "bg-custom-background-100 hover:bg-custom-background-90"
}`}
{...provided.draggableProps}
{...provided.dragHandleProps}

View File

@ -0,0 +1,54 @@
import { observer } from "mobx-react-lite";
// icons
import { X } from "lucide-react";
// helpers
import { renderLongDateFormat } from "helpers/date-time.helper";
import { capitalizeFirstLetter } from "helpers/string.helper";
// constants
import { DATE_FILTER_OPTIONS } from "constants/filters";
type Props = {
handleRemove: (val: string) => void;
values: string[];
};
export const AppliedDateFilters: React.FC<Props> = observer((props) => {
const { handleRemove, values } = props;
const getDateLabel = (value: string): string => {
let dateLabel = "";
const dateDetails = DATE_FILTER_OPTIONS.find((d) => d.value === value);
if (dateDetails) dateLabel = dateDetails.name;
else {
const dateParts = value.split(";");
if (dateParts.length === 2) {
const [date, time] = dateParts;
dateLabel = `${capitalizeFirstLetter(time)} ${renderLongDateFormat(date)}`;
}
}
return dateLabel;
};
return (
<div className="flex items-center gap-1 flex-wrap">
{values.map((date) => (
<div key={date} className="text-xs flex items-center gap-1 bg-custom-background-80 p-1 rounded">
<span className="normal-case">{getDateLabel(date)}</span>
<button
type="button"
className="grid place-items-center text-custom-text-300 hover:text-custom-text-200"
onClick={() => handleRemove(date)}
>
<X size={10} strokeWidth={2} />
</button>
</div>
))}
</div>
);
});

View File

@ -0,0 +1,141 @@
import { useRouter } from "next/router";
import { observer } from "mobx-react-lite";
// mobx store
import { useMobxStore } from "lib/mobx/store-provider";
// components
import {
AppliedDateFilters,
AppliedLabelsFilters,
AppliedMembersFilters,
AppliedPriorityFilters,
AppliedStateFilters,
AppliedStateGroupFilters,
} from "components/issues";
// icons
import { X } from "lucide-react";
// helpers
import { replaceUnderscoreIfSnakeCase } from "helpers/string.helper";
// types
import { IIssueFilterOptions } from "types";
export const AppliedFiltersList: React.FC = observer(() => {
const router = useRouter();
const { workspaceSlug, projectId } = router.query;
const { issueFilter: issueFilterStore, project: projectStore } = useMobxStore();
const userFilters = issueFilterStore.userFilters;
// filters whose value not null or empty array
const appliedFilters: IIssueFilterOptions = {};
Object.entries(userFilters).forEach(([key, value]) => {
if (!value) return;
if (Array.isArray(value) && value.length === 0) return;
appliedFilters[key as keyof IIssueFilterOptions] = value;
});
const handleRemoveFilter = (key: keyof IIssueFilterOptions, value: string | null) => {
if (!workspaceSlug || !projectId) return;
// remove all values of the key if value is null
if (!value) {
issueFilterStore.updateUserFilters(workspaceSlug.toString(), projectId.toString(), {
filters: {
[key]: null,
},
});
return;
}
// remove the passed value from the key
let newValues = issueFilterStore.userFilters?.[key] ?? [];
newValues = newValues.filter((val) => val !== value);
issueFilterStore.updateUserFilters(workspaceSlug.toString(), projectId.toString(), {
filters: {
[key]: newValues,
},
});
};
const handleClearAllFilters = () => {
if (!workspaceSlug || !projectId) return;
const newFilters: IIssueFilterOptions = {};
Object.keys(userFilters).forEach((key) => {
newFilters[key as keyof IIssueFilterOptions] = null;
});
issueFilterStore.updateUserFilters(workspaceSlug.toString(), projectId.toString(), {
filters: { ...newFilters },
});
};
// return if no filters are applied
if (Object.keys(appliedFilters).length === 0) return null;
return (
<div className="flex items-stretch gap-2 flex-wrap bg-custom-background-100 p-4">
{Object.entries(appliedFilters).map(([key, value]) => {
const filterKey = key as keyof IIssueFilterOptions;
return (
<div
key={filterKey}
className="capitalize py-1 px-2 border border-custom-border-200 rounded-md flex items-center gap-2 flex-wrap"
>
<span className="text-xs text-custom-text-300">{replaceUnderscoreIfSnakeCase(filterKey)}</span>
{(filterKey === "assignees" || filterKey === "created_by" || filterKey === "subscriber") && (
<AppliedMembersFilters
handleRemove={(val) => handleRemoveFilter(filterKey, val)}
members={projectStore.members?.[projectId?.toString() ?? ""]?.map((m) => m.member)}
values={value}
/>
)}
{(filterKey === "start_date" || filterKey === "target_date") && (
<AppliedDateFilters handleRemove={(val) => handleRemoveFilter(filterKey, val)} values={value} />
)}
{filterKey === "labels" && (
<AppliedLabelsFilters
handleRemove={(val) => handleRemoveFilter("labels", val)}
labels={projectStore.labels?.[projectId?.toString() ?? ""] ?? []}
values={value}
/>
)}
{filterKey === "priority" && (
<AppliedPriorityFilters handleRemove={(val) => handleRemoveFilter("priority", val)} values={value} />
)}
{filterKey === "state" && (
<AppliedStateFilters
handleRemove={(val) => handleRemoveFilter("state", val)}
states={projectStore.states?.[projectId?.toString() ?? ""]}
values={value}
/>
)}
{filterKey === "state_group" && (
<AppliedStateGroupFilters handleRemove={(val) => handleRemoveFilter("state_group", val)} values={value} />
)}
<button
type="button"
className="grid place-items-center text-custom-text-300 hover:text-custom-text-200"
onClick={() => handleRemoveFilter(filterKey, null)}
>
<X size={12} strokeWidth={2} />
</button>
</div>
);
})}
<button
type="button"
onClick={handleClearAllFilters}
className="flex items-center gap-2 text-xs border border-custom-border-200 py-1 px-2 rounded-md text-custom-text-300 hover:text-custom-text-200"
>
Clear all
<X size={12} strokeWidth={2} />
</button>
</div>
);
});

View File

@ -0,0 +1,7 @@
export * from "./date";
export * from "./filters-list";
export * from "./label";
export * from "./members";
export * from "./priority";
export * from "./state";
export * from "./state-group";

View File

@ -0,0 +1,45 @@
import { observer } from "mobx-react-lite";
// icons
import { X } from "lucide-react";
// types
import { IIssueLabels } from "types";
type Props = {
handleRemove: (val: string) => void;
labels: IIssueLabels[] | undefined;
values: string[];
};
export const AppliedLabelsFilters: React.FC<Props> = observer((props) => {
const { handleRemove, labels, values } = props;
return (
<div className="flex items-center gap-1 flex-wrap">
{values.map((labelId) => {
const labelDetails = labels?.find((l) => l.id === labelId);
if (!labelDetails) return null;
return (
<div key={labelId} className="text-xs flex items-center gap-1 bg-custom-background-80 p-1 rounded">
<span
className="h-1.5 w-1.5 rounded-full"
style={{
backgroundColor: labelDetails.color,
}}
/>
<span className="normal-case">{labelDetails.name}</span>
<button
type="button"
className="grid place-items-center text-custom-text-300 hover:text-custom-text-200"
onClick={() => handleRemove(labelId)}
>
<X size={10} strokeWidth={2} />
</button>
</div>
);
})}
</div>
);
});

View File

@ -0,0 +1,42 @@
import { observer } from "mobx-react-lite";
// ui
import { Avatar } from "components/ui";
// icons
import { X } from "lucide-react";
// types
import { IUserLite } from "types";
type Props = {
handleRemove: (val: string) => void;
members: IUserLite[] | undefined;
values: string[];
};
export const AppliedMembersFilters: React.FC<Props> = observer((props) => {
const { handleRemove, members, values } = props;
return (
<div className="flex items-center gap-1 flex-wrap">
{values.map((memberId) => {
const memberDetails = members?.find((m) => m.id === memberId);
if (!memberDetails) return null;
return (
<div key={memberId} className="text-xs flex items-center gap-1 bg-custom-background-80 p-1 rounded">
<Avatar user={memberDetails} height="16px" width="16px" />
<span className="normal-case">{memberDetails.display_name}</span>
<button
type="button"
className="grid place-items-center text-custom-text-300 hover:text-custom-text-200"
onClick={() => handleRemove(memberId)}
>
<X size={10} strokeWidth={2} />
</button>
</div>
);
})}
</div>
);
});

View File

@ -0,0 +1,47 @@
import { observer } from "mobx-react-lite";
// icons
import { PriorityIcon } from "components/icons";
import { X } from "lucide-react";
// types
import { TIssuePriorities } from "types";
type Props = {
handleRemove: (val: string) => void;
values: string[];
};
export const AppliedPriorityFilters: React.FC<Props> = observer((props) => {
const { handleRemove, values } = props;
return (
<div className="flex items-center gap-1 flex-wrap">
{values.map((priority) => (
<div key={priority} className="text-xs flex items-center gap-1 bg-custom-background-80 p-1 rounded">
<PriorityIcon
priority={priority as TIssuePriorities}
className={`!text-xs ${
priority === "urgent"
? "text-red-500"
: priority === "high"
? "text-orange-500"
: priority === "medium"
? "text-yellow-500"
: priority === "low"
? "text-green-500"
: ""
}`}
/>
{priority}
<button
type="button"
className="grid place-items-center text-custom-text-300 hover:text-custom-text-200"
onClick={() => handleRemove(priority)}
>
<X size={10} strokeWidth={2} />
</button>
</div>
))}
</div>
);
});

View File

@ -0,0 +1,33 @@
import { observer } from "mobx-react-lite";
// icons
import { StateGroupIcon } from "components/icons";
import { X } from "lucide-react";
import { TStateGroups } from "types";
type Props = {
handleRemove: (val: string) => void;
values: string[];
};
export const AppliedStateGroupFilters: React.FC<Props> = observer((props) => {
const { handleRemove, values } = props;
return (
<div className="flex items-center gap-1 flex-wrap">
{values.map((stateGroup) => (
<div key={stateGroup} className="text-xs flex items-center gap-1 bg-custom-background-80 p-1 rounded">
<StateGroupIcon stateGroup={stateGroup as TStateGroups} height="12px" width="12px" />
{stateGroup}
<button
type="button"
className="grid place-items-center text-custom-text-300 hover:text-custom-text-200"
onClick={() => handleRemove(stateGroup)}
>
<X size={10} strokeWidth={2} />
</button>
</div>
))}
</div>
);
});

View File

@ -0,0 +1,45 @@
import { observer } from "mobx-react-lite";
// icons
import { StateGroupIcon } from "components/icons";
import { X } from "lucide-react";
// helpers
import { getStatesList } from "helpers/state.helper";
// types
import { IStateResponse } from "types";
type Props = {
handleRemove: (val: string) => void;
states: IStateResponse | undefined;
values: string[];
};
export const AppliedStateFilters: React.FC<Props> = observer((props) => {
const { handleRemove, states, values } = props;
const statesList = getStatesList(states);
return (
<div className="flex items-center gap-1 flex-wrap">
{values.map((stateId) => {
const stateDetails = statesList?.find((s) => s.id === stateId);
if (!stateDetails) return null;
return (
<div key={stateId} className="text-xs flex items-center gap-1 bg-custom-background-80 p-1 rounded">
<StateGroupIcon color={stateDetails.color} stateGroup={stateDetails.group} height="12px" width="12px" />
{stateDetails.name}
<button
type="button"
className="grid place-items-center text-custom-text-300 hover:text-custom-text-200"
onClick={() => handleRemove(stateId)}
>
<X size={10} strokeWidth={2} />
</button>
</div>
);
})}
</div>
);
});

View File

@ -147,7 +147,7 @@ export const FilterSelection: React.FC<Props> = observer((props) => {
)}
</div>
</div>
<div className="w-full h-full divide-y divide-custom-border-20 px-2.5 overflow-y-auto">
<div className="w-full h-full divide-y divide-custom-border-200 px-2.5 overflow-y-auto">
{/* priority */}
{isFilterEnabled("priority") && (
<div className="py-2">

View File

@ -1,4 +1,4 @@
export * from "./assignees";
export * from "./assignee";
export * from "./created-by";
export * from "./filters-selection";
export * from "./labels";

View File

@ -0,0 +1,2 @@
export * from "./header";
export * from "./applied-filters";

View File

@ -1,5 +1,5 @@
export * from "./calendar";
export * from "./filters";
export * from "./gantt";
export * from "./header";
export * from "./kanban";
export * from "./spreadsheet";

View File

@ -112,22 +112,6 @@ class IssueFilterStore implements IIssueFilterStore {
return computedFilters;
};
calendarLayoutDateRange = () => {
const { activeMonthDate, activeWeekDate } = this.rootStore.calendar.calendarFilters;
const calendarLayout = this.userDisplayFilters.calendar?.layout ?? "month";
let filterDate = new Date();
if (calendarLayout === "month") filterDate = activeMonthDate;
else filterDate = activeWeekDate;
const startOfMonth = renderDateFormat(new Date(filterDate.getFullYear(), filterDate.getMonth(), 1));
const endOfMonth = renderDateFormat(new Date(filterDate.getFullYear(), filterDate.getMonth() + 1, 0));
return [`${startOfMonth};after`, `${endOfMonth};before`];
};
get appliedFilters(): TIssueParams[] | null {
if (
!this.userFilters ||
@ -155,12 +139,12 @@ class IssueFilterStore implements IIssueFilterStore {
start_target_date: this.userDisplayFilters?.start_target_date || true,
};
if (this.userDisplayFilters.layout === "calendar") filteredRouteParams.target_date = this.calendarLayoutDateRange();
if (this.userDisplayFilters.layout === "gantt_chart") filteredRouteParams.start_target_date = true;
const filteredParams = handleIssueQueryParamsByLayout(this.userDisplayFilters.layout, "issues");
if (filteredParams) filteredRouteParams = this.computedFilter(filteredRouteParams, filteredParams);
if (this.userDisplayFilters.layout === "calendar") filteredRouteParams.group_by = "target_date";
if (this.userDisplayFilters.layout === "gantt_chart") filteredRouteParams.start_target_date = true;
return filteredRouteParams;
}