[WEB-1251] chore: view list enhancement (#4427)

* chore: moved search query to mobx store

* chore: moved view sub-header to app header

* chore: created by avatar added in view item list
This commit is contained in:
Anmol Singh Bhatia 2024-05-10 15:19:05 +05:30 committed by GitHub
parent 243680132e
commit e396424db7
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
6 changed files with 109 additions and 82 deletions

View File

@ -7,6 +7,7 @@ import { Breadcrumbs, PhotoFilterIcon, Button } from "@plane/ui";
import { BreadcrumbLink } from "@/components/common"; import { BreadcrumbLink } from "@/components/common";
// helpers // helpers
import { ProjectLogo } from "@/components/project"; import { ProjectLogo } from "@/components/project";
import { ViewListHeader } from "@/components/views";
import { EUserProjectRoles } from "@/constants/project"; import { EUserProjectRoles } from "@/constants/project";
// constants // constants
import { useCommandPalette, useProject, useUser } from "@/hooks/store"; import { useCommandPalette, useProject, useUser } from "@/hooks/store";
@ -58,6 +59,7 @@ export const ProjectViewsHeader: React.FC = observer(() => {
</div> </div>
{canUserCreateIssue && ( {canUserCreateIssue && (
<div className="flex flex-shrink-0 items-center gap-2"> <div className="flex flex-shrink-0 items-center gap-2">
<ViewListHeader />
<div> <div>
<Button <Button
variant="primary" variant="primary"

View File

@ -5,3 +5,4 @@ export * from "./quick-actions";
export * from "./view-list-item"; export * from "./view-list-item";
export * from "./views-list"; export * from "./views-list";
export * from "./view-list-item-action"; export * from "./view-list-item-action";
export * from "./view-list-header";

View File

@ -0,0 +1,84 @@
import React, { useRef, useState } from "react";
import { observer } from "mobx-react";
// icons
import { Search, X } from "lucide-react";
// helpers
import { cn } from "@/helpers/common.helper";
// hooks
import { useProjectView } from "@/hooks/store";
import useOutsideClickDetector from "@/hooks/use-outside-click-detector";
export const ViewListHeader = observer(() => {
// states
const [isSearchOpen, setIsSearchOpen] = useState(false);
// const [isSearchOpen, setIsSearchOpen] = useState(searchQuery !== "" ? true : false);
// refs
const inputRef = useRef<HTMLInputElement>(null);
const { searchQuery, updateSearchQuery } = useProjectView();
// handlers
const handleInputKeyDown = (e: React.KeyboardEvent<HTMLInputElement>) => {
if (e.key === "Escape") {
if (searchQuery && searchQuery.trim() !== "") updateSearchQuery("");
else {
setIsSearchOpen(false);
inputRef.current?.blur();
}
}
};
// outside click detector hook
useOutsideClickDetector(inputRef, () => {
if (isSearchOpen && searchQuery.trim() === "") setIsSearchOpen(false);
});
return (
<div className="h-full flex items-center gap-2">
<div className="flex items-center">
{!isSearchOpen && (
<button
type="button"
className="-mr-1 p-2 hover:bg-custom-background-80 rounded text-custom-text-400 grid place-items-center"
onClick={() => {
setIsSearchOpen(true);
inputRef.current?.focus();
}}
>
<Search className="h-3.5 w-3.5" />
</button>
)}
<div
className={cn(
"ml-auto flex items-center justify-start gap-1 rounded-md border border-transparent bg-custom-background-100 text-custom-text-400 w-0 transition-[width] ease-linear overflow-hidden opacity-0",
{
"w-64 px-2.5 py-1.5 border-custom-border-200 opacity-100": isSearchOpen,
}
)}
>
<Search className="h-3.5 w-3.5" />
<input
ref={inputRef}
className="w-full max-w-[234px] border-none bg-transparent text-sm text-custom-text-100 placeholder:text-custom-text-400 focus:outline-none"
placeholder="Search"
value={searchQuery}
onChange={(e) => updateSearchQuery(e.target.value)}
onKeyDown={handleInputKeyDown}
/>
{isSearchOpen && (
<button
type="button"
className="grid place-items-center"
onClick={() => {
updateSearchQuery("");
setIsSearchOpen(false);
}}
>
<X className="h-3 w-3" />
</button>
)}
</div>
</div>
</div>
);
});

View File

@ -11,7 +11,8 @@ import { EUserProjectRoles } from "@/constants/project";
// helpers // helpers
import { calculateTotalFilters } from "@/helpers/filter.helper"; import { calculateTotalFilters } from "@/helpers/filter.helper";
// hooks // hooks
import { useProjectView, useUser } from "@/hooks/store"; import { useMember, useProjectView, useUser } from "@/hooks/store";
import { ButtonAvatars } from "../dropdowns/member/avatar";
type Props = { type Props = {
parentRef: React.RefObject<HTMLElement>; parentRef: React.RefObject<HTMLElement>;
@ -31,6 +32,7 @@ export const ViewListItemAction: FC<Props> = observer((props) => {
membership: { currentProjectRole }, membership: { currentProjectRole },
} = useUser(); } = useUser();
const { addViewToFavorites, removeViewFromFavorites } = useProjectView(); const { addViewToFavorites, removeViewFromFavorites } = useProjectView();
const { getUserDetails } = useMember();
// derived values // derived values
const isEditingAllowed = !!currentProjectRole && currentProjectRole >= EUserProjectRoles.MEMBER; const isEditingAllowed = !!currentProjectRole && currentProjectRole >= EUserProjectRoles.MEMBER;
@ -50,6 +52,8 @@ export const ViewListItemAction: FC<Props> = observer((props) => {
removeViewFromFavorites(workspaceSlug.toString(), projectId.toString(), view.id); removeViewFromFavorites(workspaceSlug.toString(), projectId.toString(), view.id);
}; };
const createdByDetails = view.created_by ? getUserDetails(view.created_by) : undefined;
return ( return (
<> <>
{workspaceSlug && projectId && view && ( {workspaceSlug && projectId && view && (
@ -65,6 +69,10 @@ export const ViewListItemAction: FC<Props> = observer((props) => {
<p className="hidden rounded bg-custom-background-80 px-2 py-1 text-xs text-custom-text-200 group-hover:block"> <p className="hidden rounded bg-custom-background-80 px-2 py-1 text-xs text-custom-text-200 group-hover:block">
{totalFilters} {totalFilters === 1 ? "filter" : "filters"} {totalFilters} {totalFilters === 1 ? "filter" : "filters"}
</p> </p>
{/* created by */}
{createdByDetails && <ButtonAvatars showTooltip={false} userIds={createdByDetails?.id} />}
{isEditingAllowed && ( {isEditingAllowed && (
<FavoriteStar <FavoriteStar
onClick={(e) => { onClick={(e) => {

View File

@ -1,7 +1,4 @@
import { useRef, useState } from "react";
import { observer } from "mobx-react-lite"; import { observer } from "mobx-react-lite";
// ui
import { Search, X } from "lucide-react";
// components // components
import { ListLayout } from "@/components/core/list"; import { ListLayout } from "@/components/core/list";
import { EmptyState } from "@/components/empty-state"; import { EmptyState } from "@/components/empty-state";
@ -9,28 +6,13 @@ import { ViewListLoader } from "@/components/ui";
import { ProjectViewListItem } from "@/components/views"; import { ProjectViewListItem } from "@/components/views";
// constants // constants
import { EmptyStateType } from "@/constants/empty-state"; import { EmptyStateType } from "@/constants/empty-state";
// helper
import { cn } from "@/helpers/common.helper";
// hooks // hooks
import { useCommandPalette, useProjectView } from "@/hooks/store"; import { useCommandPalette, useProjectView } from "@/hooks/store";
import useOutsideClickDetector from "@/hooks/use-outside-click-detector";
export const ProjectViewsList = observer(() => { export const ProjectViewsList = observer(() => {
// states
const [searchQuery, setSearchQuery] = useState("");
const [isSearchOpen, setIsSearchOpen] = useState(searchQuery !== "" ? true : false);
// refs
const inputRef = useRef<HTMLInputElement>(null);
// store hooks // store hooks
const { toggleCreateViewModal } = useCommandPalette(); const { toggleCreateViewModal } = useCommandPalette();
const { projectViewIds, getViewById, loader } = useProjectView(); const { projectViewIds, getViewById, loader, searchQuery } = useProjectView();
// outside click detector hook
useOutsideClickDetector(inputRef, () => {
if (isSearchOpen && searchQuery.trim() === "") setIsSearchOpen(false);
});
if (loader || !projectViewIds) return <ViewListLoader />; if (loader || !projectViewIds) return <ViewListLoader />;
@ -39,72 +21,10 @@ export const ProjectViewsList = observer(() => {
const filteredViewsList = viewsList.filter((v) => v?.name.toLowerCase().includes(searchQuery.toLowerCase())); const filteredViewsList = viewsList.filter((v) => v?.name.toLowerCase().includes(searchQuery.toLowerCase()));
// handlers
const handleInputKeyDown = (e: React.KeyboardEvent<HTMLInputElement>) => {
if (e.key === "Escape") {
if (searchQuery && searchQuery.trim() !== "") setSearchQuery("");
else {
setIsSearchOpen(false);
inputRef.current?.blur();
}
}
};
return ( return (
<> <>
{viewsList.length > 0 ? ( {viewsList.length > 0 ? (
<div className="flex h-full w-full flex-col"> <div className="flex h-full w-full flex-col">
<div className="h-[50px] flex-shrink-0 w-full border-b border-custom-border-200 px-6 relative flex items-center gap-4 justify-between">
<div className="flex items-center">
<span className="block text-sm font-medium">Project Views</span>
</div>
<div className="h-full flex items-center gap-2">
<div className="flex items-center">
{!isSearchOpen && (
<button
type="button"
className="-mr-1 p-2 hover:bg-custom-background-80 rounded text-custom-text-400 grid place-items-center"
onClick={() => {
setIsSearchOpen(true);
inputRef.current?.focus();
}}
>
<Search className="h-3.5 w-3.5" />
</button>
)}
<div
className={cn(
"ml-auto flex items-center justify-start gap-1 rounded-md border border-transparent bg-custom-background-100 text-custom-text-400 w-0 transition-[width] ease-linear overflow-hidden opacity-0",
{
"w-64 px-2.5 py-1.5 border-custom-border-200 opacity-100": isSearchOpen,
}
)}
>
<Search className="h-3.5 w-3.5" />
<input
ref={inputRef}
className="w-full max-w-[234px] border-none bg-transparent text-sm text-custom-text-100 placeholder:text-custom-text-400 focus:outline-none"
placeholder="Search"
value={searchQuery}
onChange={(e) => setSearchQuery(e.target.value)}
onKeyDown={handleInputKeyDown}
/>
{isSearchOpen && (
<button
type="button"
className="grid place-items-center"
onClick={() => {
setSearchQuery("");
setIsSearchOpen(false);
}}
>
<X className="h-3 w-3" />
</button>
)}
</div>
</div>
</div>
</div>
<ListLayout> <ListLayout>
{filteredViewsList.length > 0 ? ( {filteredViewsList.length > 0 ? (
filteredViewsList.map((view) => <ProjectViewListItem key={view.id} view={view} />) filteredViewsList.map((view) => <ProjectViewListItem key={view.id} view={view} />)

View File

@ -12,11 +12,13 @@ export interface IProjectViewStore {
loader: boolean; loader: boolean;
fetchedMap: Record<string, boolean>; fetchedMap: Record<string, boolean>;
// observables // observables
searchQuery: string;
viewMap: Record<string, IProjectView>; viewMap: Record<string, IProjectView>;
// computed // computed
projectViewIds: string[] | null; projectViewIds: string[] | null;
// computed actions // computed actions
getViewById: (viewId: string) => IProjectView; getViewById: (viewId: string) => IProjectView;
updateSearchQuery: (query: string) => void;
// fetch actions // fetch actions
fetchViews: (workspaceSlug: string, projectId: string) => Promise<undefined | IProjectView[]>; fetchViews: (workspaceSlug: string, projectId: string) => Promise<undefined | IProjectView[]>;
fetchViewDetails: (workspaceSlug: string, projectId: string, viewId: string) => Promise<IProjectView>; fetchViewDetails: (workspaceSlug: string, projectId: string, viewId: string) => Promise<IProjectView>;
@ -38,6 +40,7 @@ export class ProjectViewStore implements IProjectViewStore {
// observables // observables
loader: boolean = false; loader: boolean = false;
viewMap: Record<string, IProjectView> = {}; viewMap: Record<string, IProjectView> = {};
searchQuery: string = "";
//loaders //loaders
fetchedMap: Record<string, boolean> = {}; fetchedMap: Record<string, boolean> = {};
// root store // root store
@ -51,6 +54,7 @@ export class ProjectViewStore implements IProjectViewStore {
loader: observable.ref, loader: observable.ref,
viewMap: observable, viewMap: observable,
fetchedMap: observable, fetchedMap: observable,
searchQuery: observable.ref,
// computed // computed
projectViewIds: computed, projectViewIds: computed,
// fetch actions // fetch actions
@ -60,6 +64,8 @@ export class ProjectViewStore implements IProjectViewStore {
createView: action, createView: action,
updateView: action, updateView: action,
deleteView: action, deleteView: action,
// actions
updateSearchQuery: action,
// favorites actions // favorites actions
addViewToFavorites: action, addViewToFavorites: action,
removeViewFromFavorites: action, removeViewFromFavorites: action,
@ -85,6 +91,12 @@ export class ProjectViewStore implements IProjectViewStore {
*/ */
getViewById = computedFn((viewId: string) => this.viewMap?.[viewId] ?? null); getViewById = computedFn((viewId: string) => this.viewMap?.[viewId] ?? null);
/**
* @description update search query
* @param {string} query
*/
updateSearchQuery = (query: string) => (this.searchQuery = query);
/** /**
* Fetches views for current project * Fetches views for current project
* @param workspaceSlug * @param workspaceSlug