mirror of
https://github.com/documenso/documenso.git
synced 2025-11-13 08:13:56 +10:00
Rework: - Field styling to improve visibility - Field insertions, better alignment, centering and overflows ## Changes General changes: - Set default text alignment to left if no meta found - Reduce borders and rings around fields to allow smaller fields - Removed lots of redundant duplicated code surrounding field rendering - Make fields more consistent across viewing, editing and signing - Add more transparency to fields to allow users to see under fields - No more optional/required/etc colors when signing, required fields will be highlighted as orange when form is "validating" Highlighted internal changes: - Utilize native PDF fields to insert text, instead of drawing text - Change font auto scaling to only apply to when the height overflows AND no custom font is set ⚠️ Multiline changes: Multi line is enabled for a field under these conditions 1. Field content exceeds field width 2. Field includes a new line 3. Field type is TEXT ## [BEFORE] Field UI Signing  ## [AFTER] Field UI Signing  ## [BEFORE] Signing a checkbox   ## [AFTER] Signing a checkbox   ## [BEFORE] What a 2nd recipient sees once someone else signed a document  ## [AFTER] What a 2nd recipient sees once someone else signed a document  ## **[BEFORE]** Inserting fields  ## **[AFTER]** Inserting fields  ## Overflows, multilines and field alignments testing Debugging borders: - Red border = The original field placement without any modifications - Blue border = The available space to overflow ### Single line overflows and field alignments This is left aligned fields, overflow will always go to the end of the page and will not wrap  This is center aligned fields, the max width is the closest edge to the page * 2  This is right aligned text, the width will extend all the way to the left hand side of the page  ### Multiline line overflows and field alignments These are text fields that can be overflowed  Another example of left aligned text overflows with more text 
202 lines
6.0 KiB
TypeScript
202 lines
6.0 KiB
TypeScript
import React from 'react';
|
|
|
|
import { Trans } from '@lingui/react/macro';
|
|
import { FieldType } from '@prisma/client';
|
|
import { TooltipArrow } from '@radix-ui/react-tooltip';
|
|
import { X } from 'lucide-react';
|
|
|
|
import { type TRecipientActionAuth } from '@documenso/lib/types/document-auth';
|
|
import { ZFieldMetaSchema } from '@documenso/lib/types/field-meta';
|
|
import type { FieldWithSignature } from '@documenso/prisma/types/field-with-signature';
|
|
import { FieldRootContainer } from '@documenso/ui/components/field/field';
|
|
import { RECIPIENT_COLOR_STYLES } from '@documenso/ui/lib/recipient-colors';
|
|
import { cn } from '@documenso/ui/lib/utils';
|
|
import { Tooltip, TooltipContent, TooltipTrigger } from '@documenso/ui/primitives/tooltip';
|
|
|
|
import { useRequiredDocumentSigningAuthContext } from './document-signing-auth-provider';
|
|
|
|
export type DocumentSigningFieldContainerProps = {
|
|
field: FieldWithSignature;
|
|
loading?: boolean;
|
|
children: React.ReactNode;
|
|
|
|
/**
|
|
* A function that is called before the field requires to be signed, or reauthed.
|
|
*
|
|
* Example, you may want to show a dialog prior to signing where they can enter a value.
|
|
*
|
|
* Once that action is complete, you will need to call `executeActionAuthProcedure` to proceed
|
|
* regardless if it requires reauth or not.
|
|
*
|
|
* If the function returns true, we will proceed with the signing process. Otherwise if
|
|
* false is returned we will not proceed.
|
|
*/
|
|
onPreSign?: () => Promise<boolean> | boolean;
|
|
|
|
/**
|
|
* The function required to be executed to insert the field.
|
|
*
|
|
* The auth values will be passed in if available.
|
|
*/
|
|
onSign?: (documentAuthValue?: TRecipientActionAuth) => Promise<void> | void;
|
|
onRemove?: (fieldType?: string) => Promise<void> | void;
|
|
type?:
|
|
| 'Date'
|
|
| 'Initials'
|
|
| 'Email'
|
|
| 'Name'
|
|
| 'Signature'
|
|
| 'Text'
|
|
| 'Radio'
|
|
| 'Dropdown'
|
|
| 'Number'
|
|
| 'Checkbox';
|
|
tooltipText?: string | null;
|
|
};
|
|
|
|
export const DocumentSigningFieldContainer = ({
|
|
field,
|
|
loading,
|
|
onPreSign,
|
|
onSign,
|
|
onRemove,
|
|
children,
|
|
type,
|
|
tooltipText,
|
|
}: DocumentSigningFieldContainerProps) => {
|
|
const { executeActionAuthProcedure, isAuthRedirectRequired } =
|
|
useRequiredDocumentSigningAuthContext();
|
|
|
|
const parsedFieldMeta = field.fieldMeta ? ZFieldMetaSchema.parse(field.fieldMeta) : undefined;
|
|
const readOnlyField = parsedFieldMeta?.readOnly || false;
|
|
|
|
const handleInsertField = async () => {
|
|
if (field.inserted || !onSign) {
|
|
return;
|
|
}
|
|
|
|
// Bypass reauth for non signature fields.
|
|
if (field.type !== FieldType.SIGNATURE) {
|
|
const presignResult = await onPreSign?.();
|
|
|
|
if (presignResult === false) {
|
|
return;
|
|
}
|
|
|
|
await onSign();
|
|
return;
|
|
}
|
|
|
|
if (isAuthRedirectRequired) {
|
|
await executeActionAuthProcedure({
|
|
onReauthFormSubmit: () => {
|
|
// Do nothing since the user should be redirected.
|
|
},
|
|
actionTarget: field.type,
|
|
});
|
|
|
|
return;
|
|
}
|
|
|
|
// Handle any presign requirements, and halt if required.
|
|
if (onPreSign) {
|
|
const preSignResult = await onPreSign();
|
|
|
|
if (preSignResult === false) {
|
|
return;
|
|
}
|
|
}
|
|
|
|
await executeActionAuthProcedure({
|
|
onReauthFormSubmit: onSign,
|
|
actionTarget: field.type,
|
|
});
|
|
};
|
|
|
|
const onRemoveSignedFieldClick = async () => {
|
|
if (!field.inserted) {
|
|
return;
|
|
}
|
|
|
|
await onRemove?.();
|
|
};
|
|
|
|
const onClearCheckBoxValues = async (fieldType?: string) => {
|
|
if (!field.inserted) {
|
|
return;
|
|
}
|
|
|
|
await onRemove?.(fieldType);
|
|
};
|
|
|
|
return (
|
|
<div className={cn('[container-type:size]')}>
|
|
<FieldRootContainer color={RECIPIENT_COLOR_STYLES.green} field={field}>
|
|
{!field.inserted && !loading && !readOnlyField && (
|
|
<button
|
|
type="submit"
|
|
className="absolute inset-0 z-10 h-full w-full rounded-[2px]"
|
|
onClick={async () => handleInsertField()}
|
|
/>
|
|
)}
|
|
|
|
{readOnlyField && (
|
|
<button className="bg-background/40 absolute inset-0 z-10 flex h-full w-full items-center justify-center rounded-md text-sm opacity-0 duration-200 group-hover:opacity-100">
|
|
<span className="bg-foreground/50 text-background rounded-xl p-2">
|
|
<Trans>Read only field</Trans>
|
|
</span>
|
|
</button>
|
|
)}
|
|
|
|
{type === 'Checkbox' && field.inserted && !loading && !readOnlyField && (
|
|
<button
|
|
className="absolute -bottom-10 flex items-center justify-evenly rounded-md border bg-gray-900 opacity-0 group-hover:opacity-100"
|
|
onClick={() => void onClearCheckBoxValues(type)}
|
|
>
|
|
<span className="rounded-md p-1 text-gray-400 transition-colors hover:bg-white/10 hover:text-gray-100">
|
|
<X className="h-4 w-4" />
|
|
</span>
|
|
</button>
|
|
)}
|
|
|
|
{type !== 'Checkbox' && field.inserted && !loading && !readOnlyField && (
|
|
<Tooltip delayDuration={0}>
|
|
<TooltipTrigger asChild>
|
|
<button className="absolute inset-0 z-10" onClick={onRemoveSignedFieldClick}></button>
|
|
</TooltipTrigger>
|
|
|
|
<TooltipContent
|
|
className="border-0 bg-orange-300 fill-orange-300 font-bold text-orange-900"
|
|
sideOffset={2}
|
|
>
|
|
{tooltipText && <p>{tooltipText}</p>}
|
|
|
|
<Trans>Remove</Trans>
|
|
<TooltipArrow />
|
|
</TooltipContent>
|
|
</Tooltip>
|
|
)}
|
|
|
|
{(field.type === FieldType.RADIO || field.type === FieldType.CHECKBOX) &&
|
|
field.fieldMeta?.label && (
|
|
<div
|
|
className={cn(
|
|
'absolute -top-16 left-0 right-0 rounded-md p-2 text-center text-xs text-gray-700',
|
|
{
|
|
'bg-foreground/5 border-border border': !field.inserted,
|
|
},
|
|
{
|
|
'bg-documenso-200 border-primary border': field.inserted,
|
|
},
|
|
)}
|
|
>
|
|
{field.fieldMeta.label}
|
|
</div>
|
|
)}
|
|
|
|
{children}
|
|
</FieldRootContainer>
|
|
</div>
|
|
);
|
|
};
|