From 95fcd10430d046d4cab9ac4669e7223d8c55c7dd Mon Sep 17 00:00:00 2001
From: Gustav Larsson <gustav.larsson@gmail.com>
Date: Thu, 4 Jul 2024 13:05:33 +0200
Subject: [PATCH] Add Drawer header story

---
 .storybook/preview.js                         |  15 +-
 components/DrawerHeader.tsx                   |  28 +++-
 .../legal-documents/LegalDocumentDrawer.tsx   |   6 +-
 .../TransactionsImportRowDrawer.tsx           |   6 +-
 .../transactions/TransactionDrawer.tsx        |   9 +-
 lib/actions/types.ts                          |   3 +-
 stories/patterns/DrawerHeader.stories.tsx     | 158 ++++++++++++++++++
 7 files changed, 199 insertions(+), 26 deletions(-)
 create mode 100644 stories/patterns/DrawerHeader.stories.tsx

diff --git a/.storybook/preview.js b/.storybook/preview.js
index 6e5642a9a16..45e279530f3 100644
--- a/.storybook/preview.js
+++ b/.storybook/preview.js
@@ -10,6 +10,7 @@ import { RouterContext } from 'next/dist/shared/lib/router-context.shared-runtim
 import { Toaster } from '../components/ui/Toaster';
 import { TooltipProvider } from '../components/ui/Tooltip';
 import UserProvider from '../components/UserProvider';
+import { ModalProvider } from '../components/ModalContext';
 
 import 'react-pdf/dist/esm/Page/TextLayer.css';
 import 'react-pdf/dist/esm/Page/AnnotationLayer.css';
@@ -33,12 +34,14 @@ export const decorators = [
     <ApolloProvider client={initClient()}>
       <ThemeProvider theme={theme}>
         <IntlProvider locale="en">
-          <UserProvider>
-            <TooltipProvider>
-              <Story />
-              <Toaster />
-            </TooltipProvider>
-          </UserProvider>
+          <ModalProvider>
+            <UserProvider>
+              <TooltipProvider>
+                <Story />
+                <Toaster />
+              </TooltipProvider>
+            </UserProvider>
+          </ModalProvider>
         </IntlProvider>
       </ThemeProvider>
     </ApolloProvider>
diff --git a/components/DrawerHeader.tsx b/components/DrawerHeader.tsx
index dcfbf8bd4af..1e2ee2bf489 100644
--- a/components/DrawerHeader.tsx
+++ b/components/DrawerHeader.tsx
@@ -3,6 +3,7 @@ import clsx from 'clsx';
 import { MoreHorizontal, X } from 'lucide-react';
 import { FormattedMessage } from 'react-intl';
 
+import type { Action } from '../lib/actions/types';
 import { useWindowResize, VIEWPORTS } from '../lib/hooks/useWindowResize';
 
 import { DropdownActionItem } from './table/RowActionsMenu';
@@ -10,7 +11,18 @@ import { Button } from './ui/Button';
 import { DropdownMenu, DropdownMenuContent, DropdownMenuSeparator, DropdownMenuTrigger } from './ui/DropdownMenu';
 import { SheetClose } from './ui/Sheet';
 
-export default function DrawerHeader({ actions, entityName, entityIdentifier, entityLabel, dropdownTriggerRef }) {
+type DrawerHeaderProps = {
+  actions?: {
+    primary?: Action[];
+    secondary?: Action[];
+  };
+  entity: React.ReactNode;
+  identifier: React.ReactNode;
+  label: React.ReactNode;
+  dropdownTriggerRef?: React.RefObject<HTMLButtonElement>;
+};
+
+export default function DrawerHeader({ actions, entity, identifier, label, dropdownTriggerRef }: DrawerHeaderProps) {
   const { viewport } = useWindowResize();
   const isMobile = viewport === VIEWPORTS.XSMALL;
   const { primary, secondary } = actions || {};
@@ -20,9 +32,9 @@ export default function DrawerHeader({ actions, entityName, entityIdentifier, en
     <div className="flex flex-col gap-1 border-b px-6 py-4">
       <div className={clsx('flex items-center justify-between gap-4')}>
         <div className="flex shrink grow items-center gap-1 text-sm text-muted-foreground">
-          <span className="whitespace-nowrap">{entityName}</span>
+          <span className="whitespace-nowrap">{entity}</span>
 
-          <div className="w-0 max-w-fit flex-1">{entityIdentifier}</div>
+          <div className="w-0 max-w-fit flex-1">{identifier}</div>
         </div>
 
         <div className="flex items-center gap-1">
@@ -37,14 +49,14 @@ export default function DrawerHeader({ actions, entityName, entityIdentifier, en
         </div>
       </div>
       <div className="flex justify-between">
-        <div className="flex items-center gap-2">{entityLabel}</div>
+        <div className="flex items-center gap-2 text-xl font-semibold">{label}</div>
 
         <div className="flex items-center gap-1">
           <div className="hidden items-center gap-1 sm:flex">
             {primary?.map(action => (
               <Button
-                key={action.label}
-                variant="outline"
+                key={action.key}
+                variant={action.variant || 'outline'}
                 size="xs"
                 className="gap-1.5"
                 onClick={action.onClick}
@@ -67,11 +79,11 @@ export default function DrawerHeader({ actions, entityName, entityIdentifier, en
                 </Button>
               </DropdownMenuTrigger>
               <DropdownMenuContent align="end">
-                {isMobile && primary?.map(action => <DropdownActionItem key={action.label} action={action} />)}
+                {isMobile && primary?.map(action => <DropdownActionItem key={action.key} action={action} />)}
 
                 {isMobile && primary.length > 0 && secondary.length > 0 && <DropdownMenuSeparator />}
 
-                {secondary?.map(action => <DropdownActionItem key={action.label} action={action} />)}
+                {secondary?.map(action => <DropdownActionItem key={action.key} action={action} />)}
               </DropdownMenuContent>
             </DropdownMenu>
           )}
diff --git a/components/dashboard/sections/legal-documents/LegalDocumentDrawer.tsx b/components/dashboard/sections/legal-documents/LegalDocumentDrawer.tsx
index 679d10e9df7..acd055e2e3d 100644
--- a/components/dashboard/sections/legal-documents/LegalDocumentDrawer.tsx
+++ b/components/dashboard/sections/legal-documents/LegalDocumentDrawer.tsx
@@ -84,9 +84,9 @@ export default function LegalDocumentDrawer({
           <DrawerHeader
             dropdownTriggerRef={dropdownTriggerRef}
             actions={getActions(document, dropdownTriggerRef)}
-            entityName={intl.formatMessage({ defaultMessage: 'Tax form', id: 'TaxForm' })}
-            entityIdentifier={<CopyID value={document.id}>{document.id}</CopyID>}
-            entityLabel={
+            entity={intl.formatMessage({ defaultMessage: 'Tax form', id: 'TaxForm' })}
+            identifier={<CopyID value={document.id}>{document.id}</CopyID>}
+            label={
               <AccountHoverCard
                 account={document.account}
                 trigger={
diff --git a/components/dashboard/sections/transactions-imports/TransactionsImportRowDrawer.tsx b/components/dashboard/sections/transactions-imports/TransactionsImportRowDrawer.tsx
index 9cec294ea1e..db2b67b3fa5 100644
--- a/components/dashboard/sections/transactions-imports/TransactionsImportRowDrawer.tsx
+++ b/components/dashboard/sections/transactions-imports/TransactionsImportRowDrawer.tsx
@@ -33,8 +33,8 @@ export const TransactionsImportRowDrawer = ({
           <React.Fragment>
             <DrawerHeader
               actions={getActions(row, dropdownTriggerRef)}
-              entityName={<FormattedMessage defaultMessage="Transaction import row" id="qqPBY/" />}
-              entityLabel={
+              entity={<FormattedMessage defaultMessage="Transaction import row" id="qqPBY/" />}
+              label={
                 <div className="text-2xl">
                   <span className={'font-bold text-foreground'}>
                     <FormattedMoneyAmount
@@ -50,7 +50,7 @@ export const TransactionsImportRowDrawer = ({
                 </div>
               }
               dropdownTriggerRef={dropdownTriggerRef}
-              entityIdentifier={
+              identifier={
                 <FormattedMessage defaultMessage="No. {number}" id="rowNumber" values={{ number: rowIndex + 1 }} />
               }
             />
diff --git a/components/dashboard/sections/transactions/TransactionDrawer.tsx b/components/dashboard/sections/transactions/TransactionDrawer.tsx
index babb082cc58..89fd1b4e55e 100644
--- a/components/dashboard/sections/transactions/TransactionDrawer.tsx
+++ b/components/dashboard/sections/transactions/TransactionDrawer.tsx
@@ -265,13 +265,13 @@ function TransactionDetails({ transactionId, getActions }: TransactionDetailsPro
       <DrawerHeader
         actions={actions}
         dropdownTriggerRef={dropdownTriggerRef}
-        entityName={<FormattedMessage defaultMessage="Transaction" id="1+ROfp" />}
-        entityIdentifier={
+        entity={<FormattedMessage defaultMessage="Transaction" id="1+ROfp" />}
+        identifier={
           <CopyID value={id} tooltipLabel={<FormattedMessage defaultMessage="Copy transaction ID" id="zzd7ZI" />}>
             #{id}
           </CopyID>
         }
-        entityLabel={
+        label={
           <React.Fragment>
             {loading ? (
               <Skeleton className="h-8 w-48" />
@@ -286,8 +286,7 @@ function TransactionDetails({ transactionId, getActions }: TransactionDetailsPro
                       amountStyles={{ letterSpacing: 0 }}
                       showCurrencyCode={false}
                     />
-                  </span>
-
+                  </span>{' '}
                   <span className="text-muted-foreground">{transaction?.netAmount.currency}</span>
                 </div>
               )
diff --git a/lib/actions/types.ts b/lib/actions/types.ts
index d4f9109e003..22d5f1a7d32 100644
--- a/lib/actions/types.ts
+++ b/lib/actions/types.ts
@@ -1,11 +1,12 @@
 import type { LucideIcon } from 'lucide-react';
 import type React from 'react';
 
-type Action = {
+export type Action = {
   label: React.ReactNode;
   onClick: () => void;
   Icon?: LucideIcon;
   isLoading?: boolean;
+  variant?: string; // TODO: use button variant
   disabled?: boolean;
   'data-cy'?: string;
   key: string;
diff --git a/stories/patterns/DrawerHeader.stories.tsx b/stories/patterns/DrawerHeader.stories.tsx
new file mode 100644
index 00000000000..77d7f629308
--- /dev/null
+++ b/stories/patterns/DrawerHeader.stories.tsx
@@ -0,0 +1,158 @@
+import React from 'react';
+import { Delete, Pencil, Share, Trash } from 'lucide-react';
+
+import DrawerHeader from '../../components/DrawerHeader';
+import { Button } from '../../components/ui/Button';
+import { Sheet, SheetContent, SheetTrigger } from '../../components/ui/Sheet';
+import { CopyID } from '../../components/CopyId';
+import { useModal } from '../../components/ModalContext';
+import { Input } from '../../components/ui/Input';
+
+const meta = {
+  component: DrawerHeader,
+  parameters: {
+    docs: {
+      description: {
+        component: `
+The \`DrawerHeader\` component is used to display the header section within a drawer. 
+It includes an identifier, a name, a label, and a set of actions that can be taken.
+
+## Usage
+The \`DrawerHeader\` component is typically used inside a \`Sheet\` component to provide a context-specific header with actions for entities like transactions or other data types.
+
+### Props
+#### Entity
+This is the name of the entity being displayed in the header, e.g. "Agreement", "Transaction", "Expense", etc.
+
+#### Identifier
+This is the unique identifier of the entity being displayed in the header, e.g. the ID of the agreement, the transaction ID, etc.
+
+#### Label
+This is the label/title of the entity being displayed in the header, which might be different things depending on the enitity e.g. "Coworking at Kolgruvan" for an Agreement, "$43.21 USD" for a Transaction, Avatar + "BackYourStack" for a Collective
+
+## Example
+This example demonstrates how to use \`DrawerHeader\` with a primary action to edit the entity.
+
+\`\`\`jsx
+<Sheet>
+    <SheetTrigger asChild>
+        <Button>Open drawer</Button>
+    </SheetTrigger>
+    <SheetContent>
+        <DrawerHeader
+            identifier={<CopyID value={account.id}>#{account.id}</CopyID>}
+            entity="Agreement"
+            label="Test Collective"
+            actions={{
+              primary: [
+                {
+                  key: 'edit',
+                  label: 'Edit',
+                  onClick: () => {},
+                  Icon: Pencil,
+                },
+              ],
+              secondary: [
+                {
+                  key: 'share',
+                  label: 'Share',
+                  onClick: () => {},
+                  Icon: Share,
+                },
+                {
+                  key: 'delete',
+                  label: 'Delete',
+                  onClick: () => {},
+                  Icon: Trash,
+                },
+              ],
+            }}
+          />
+        {/* Drawer contents */}
+    </SheetContent>
+</Sheet>
+\`\`\`
+          `,
+      },
+    },
+  },
+};
+
+export default meta;
+
+const ExampleComponent: React.FC = () => {
+  const account = {
+    id: '1234',
+  };
+  const { showConfirmationModal } = useModal();
+  const [isEditing, setEditing] = React.useState(false);
+  const defaultActions = {
+    primary: [
+      {
+        key: 'edit',
+        label: 'Edit',
+        onClick: () => setEditing(true),
+        Icon: Pencil,
+      },
+    ],
+    secondary: [
+      {
+        key: 'share',
+        label: 'Share',
+        onClick: () => {},
+        Icon: Share,
+      },
+      {
+        key: 'delete',
+        label: 'Delete',
+        onClick: () =>
+          showConfirmationModal({
+            title: 'Delete agreement?',
+            description: 'This will permanently delete the agreement and all attachments and comments.',
+            confirmLabel: 'Delete',
+            variant: 'destructive',
+            onConfirm: () => {},
+          }),
+        Icon: Trash,
+      },
+    ],
+  };
+  const editingActions = {
+    primary: [
+      {
+        key: 'cancel',
+        label: 'Cancel',
+        variant: 'outline',
+        onClick: () => {
+          setEditing(false);
+        },
+      },
+      {
+        key: 'save',
+        label: 'Save',
+        variant: 'default',
+        onClick: () => setEditing(false),
+        // Icon: Check,
+      },
+    ],
+  };
+  const label = 'Coworking at Kolgruvan';
+  return (
+    <Sheet>
+      <SheetTrigger asChild>
+        <Button>Open drawer</Button>
+      </SheetTrigger>
+      <SheetContent>
+        <DrawerHeader
+          identifier={<CopyID value={account.id}>#{account.id}</CopyID>}
+          entity="Agreement"
+          label={label}
+          actions={isEditing ? editingActions : defaultActions}
+        />
+      </SheetContent>
+    </Sheet>
+  );
+};
+export const Example = {
+  render: () => <ExampleComponent />,
+};