feat: address composite field (#4492)

Added new Address field input type.

---------

Co-authored-by: Lucas Bordeau <bordeau.lucas@gmail.com>

packages/twenty-front/src/modules/ui/field/input/components/AddressInput.tsx

@@ -0,0 +1,254 @@
+import { RefObject, useEffect, useRef, useState } from 'react';
+import { useTheme } from '@emotion/react';
+import styled from '@emotion/styled';
+import { flip, offset, useFloating } from '@floating-ui/react';
+import { Key } from 'ts-key-enum';
+
+import { FieldAddressDraftValue } from '@/object-record/record-field/types/FieldInputDraftValue';
+import { FieldAddressValue } from '@/object-record/record-field/types/FieldMetadata';
+import { CountrySelect } from '@/ui/input/components/internal/country/components/CountrySelect';
+import { TextInput } from '@/ui/input/components/TextInput';
+import { useScopedHotkeys } from '@/ui/utilities/hotkey/hooks/useScopedHotkeys';
+import { useClickOutsideListener } from '@/ui/utilities/pointer-event/hooks/useClickOutsideListener';
+import { isDefined } from '~/utils/isDefined';
+
+const StyledAddressContainer = styled.div`
+  background: ${({ theme }) => theme.background.secondary};
+  border: 1px solid ${({ theme }) => theme.border.color.light};
+  border-radius: ${({ theme }) => theme.border.radius.md};
+  box-shadow: ${({ theme }) => theme.boxShadow.strong};
+
+  padding: 4px 8px;
+
+  width: 100%;
+  min-width: 260px;
+  > div {
+    margin-bottom: 6px;
+  }
+`;
+
+const StyledHalfRowContainer = styled.div`
+  display: flex;
+  gap: 8px;
+`;
+
+export type AddressInputProps = {
+  value: FieldAddressValue;
+  onTab: (newAddress: FieldAddressDraftValue) => void;
+  onShiftTab: (newAddress: FieldAddressDraftValue) => void;
+  onEnter: (newAddress: FieldAddressDraftValue) => void;
+  onEscape: (newAddress: FieldAddressDraftValue) => void;
+  onClickOutside: (
+    event: MouseEvent | TouchEvent,
+    newAddress: FieldAddressDraftValue,
+  ) => void;
+  hotkeyScope: string;
+  clearable?: boolean;
+  onChange?: (updatedValue: FieldAddressDraftValue) => void;
+};
+
+export const AddressInput = ({
+  value,
+  hotkeyScope,
+  onTab,
+  onShiftTab,
+  onEnter,
+  onEscape,
+  onClickOutside,
+  onChange,
+}: AddressInputProps) => {
+  const theme = useTheme();
+
+  const [internalValue, setInternalValue] = useState(value);
+  const addressStreet1InputRef = useRef<HTMLInputElement>(null);
+  const addressStreet2InputRef = useRef<HTMLInputElement>(null);
+  const addressCityInputRef = useRef<HTMLInputElement>(null);
+  const addressStateInputRef = useRef<HTMLInputElement>(null);
+  const addressPostCodeInputRef = useRef<HTMLInputElement>(null);
+
+  const inputRefs: {
+    [key in keyof FieldAddressDraftValue]?: RefObject<HTMLInputElement>;
+  } = {
+    addressStreet1: addressStreet1InputRef,
+    addressStreet2: addressStreet2InputRef,
+    addressCity: addressCityInputRef,
+    addressState: addressStateInputRef,
+    addressPostcode: addressPostCodeInputRef,
+  };
+
+  const [focusPosition, setFocusPosition] =
+    useState<keyof FieldAddressDraftValue>('addressStreet1');
+
+  const wrapperRef = useRef<HTMLDivElement>(null);
+
+  const { refs, floatingStyles } = useFloating({
+    placement: 'top-start',
+    middleware: [
+      flip(),
+      offset({
+        mainAxis: theme.spacingMultiplicator * 2,
+      }),
+    ],
+  });
+
+  const getChangeHandler =
+    (field: keyof FieldAddressDraftValue) => (updatedAddressPart: string) => {
+      const updatedAddress = { ...value, [field]: updatedAddressPart };
+      setInternalValue(updatedAddress);
+      onChange?.(updatedAddress);
+    };
+
+  const getFocusHandler = (fieldName: keyof FieldAddressDraftValue) => () => {
+    setFocusPosition(fieldName);
+
+    inputRefs[fieldName]?.current?.focus();
+  };
+
+  useScopedHotkeys(
+    'tab',
+    () => {
+      const currentFocusPosition = Object.keys(inputRefs).findIndex(
+        (key) => key === focusPosition,
+      );
+      const maxFocusPosition = Object.keys(inputRefs).length - 1;
+
+      const nextFocusPosition = currentFocusPosition + 1;
+
+      const isFocusPositionAfterLast = nextFocusPosition > maxFocusPosition;
+
+      if (isFocusPositionAfterLast) {
+        onTab?.(internalValue);
+      } else {
+        const nextFocusFieldName = Object.keys(inputRefs)[
+          nextFocusPosition
+        ] as keyof FieldAddressDraftValue;
+
+        setFocusPosition(nextFocusFieldName);
+        inputRefs[nextFocusFieldName]?.current?.focus();
+      }
+    },
+    hotkeyScope,
+    [onTab, internalValue, focusPosition],
+  );
+
+  useScopedHotkeys(
+    'shift+tab',
+    () => {
+      const currentFocusPosition = Object.keys(inputRefs).findIndex(
+        (key) => key === focusPosition,
+      );
+
+      const nextFocusPosition = currentFocusPosition - 1;
+
+      const isFocusPositionBeforeFirst = nextFocusPosition < 0;
+
+      if (isFocusPositionBeforeFirst) {
+        onShiftTab?.(internalValue);
+      } else {
+        const nextFocusFieldName = Object.keys(inputRefs)[
+          nextFocusPosition
+        ] as keyof FieldAddressDraftValue;
+
+        setFocusPosition(nextFocusFieldName);
+        inputRefs[nextFocusFieldName]?.current?.focus();
+      }
+    },
+    hotkeyScope,
+    [onTab, internalValue, focusPosition],
+  );
+
+  useScopedHotkeys(
+    Key.Enter,
+    () => {
+      onEnter(internalValue);
+    },
+    hotkeyScope,
+    [onEnter, internalValue],
+  );
+
+  useScopedHotkeys(
+    [Key.Escape],
+    () => {
+      onEscape(internalValue);
+    },
+    hotkeyScope,
+    [onEscape, internalValue],
+  );
+
+  const { useListenClickOutside } = useClickOutsideListener('addressInput');
+
+  useListenClickOutside({
+    refs: [wrapperRef],
+    callback: (event) => {
+      event.stopImmediatePropagation();
+
+      onClickOutside?.(event, internalValue);
+    },
+    enabled: isDefined(onClickOutside),
+  });
+
+  useEffect(() => {
+    setInternalValue(value);
+  }, [value]);
+
+  return (
+    <div ref={refs.setFloating} style={floatingStyles}>
+      <StyledAddressContainer ref={wrapperRef}>
+        <TextInput
+          autoFocus
+          value={internalValue.addressStreet1 ?? ''}
+          ref={inputRefs['addressStreet1']}
+          label="ADDRESS 1"
+          fullWidth
+          onChange={getChangeHandler('addressStreet1')}
+          onFocus={getFocusHandler('addressStreet1')}
+          disableHotkeys
+        />
+        <TextInput
+          value={internalValue.addressStreet2 ?? ''}
+          ref={inputRefs['addressStreet2']}
+          label="ADDRESS 2"
+          fullWidth
+          onChange={getChangeHandler('addressStreet2')}
+          onFocus={getFocusHandler('addressStreet2')}
+          disableHotkeys
+        />
+        <StyledHalfRowContainer>
+          <TextInput
+            value={internalValue.addressCity ?? ''}
+            ref={inputRefs['addressCity']}
+            label="CITY"
+            fullWidth
+            onChange={getChangeHandler('addressCity')}
+            onFocus={getFocusHandler('addressCity')}
+            disableHotkeys
+          />
+          <TextInput
+            value={internalValue.addressState ?? ''}
+            ref={inputRefs['addressState']}
+            label="STATE"
+            fullWidth
+            onChange={getChangeHandler('addressState')}
+            onFocus={getFocusHandler('addressState')}
+            disableHotkeys
+          />
+        </StyledHalfRowContainer>
+        <StyledHalfRowContainer>
+          <TextInput
+            value={internalValue.addressPostcode ?? ''}
+            ref={inputRefs['addressPostcode']}
+            label="POST CODE"
+            fullWidth
+            onChange={getChangeHandler('addressPostcode')}
+            onFocus={getFocusHandler('addressPostcode')}
+            disableHotkeys
+          />
+          <CountrySelect
+            onChange={getChangeHandler('addressCountry')}
+            selectedCountryName={internalValue.addressCountry ?? ''}
+          />
+        </StyledHalfRowContainer>
+      </StyledAddressContainer>
+    </div>
+  );
+};

packages/twenty-front/src/modules/ui/field/input/components/DoubleTextInput.tsx

@@ -13,7 +13,7 @@ import { useScopedHotkeys } from '@/ui/utilities/hotkey/hooks/useScopedHotkeys';
 import { useListenClickOutside } from '@/ui/utilities/pointer-event/hooks/useListenClickOutside';
 import { isDefined } from '~/utils/isDefined';
 
-import { StyledInput } from './TextInput';
+import { StyledTextInput } from './TextInput';
 
 const StyledContainer = styled.div`
   align-items: center;
@@ -174,7 +174,7 @@ export const DoubleTextInput = ({
 
   return (
     <StyledContainer ref={containerRef}>
-      <StyledInput
+      <StyledTextInput
         autoComplete="off"
         autoFocus
         onFocus={() => setFocusPosition('left')}
@@ -188,7 +188,7 @@ export const DoubleTextInput = ({
           handleOnPaste(event)
         }
       />
-      <StyledInput
+      <StyledTextInput
         autoComplete="off"
         onFocus={() => setFocusPosition('right')}
         ref={secondValueInputRef}

packages/twenty-front/src/modules/ui/field/input/components/PhoneInput.tsx

@@ -3,7 +3,7 @@ import ReactPhoneNumberInput from 'react-phone-number-input';
 import styled from '@emotion/styled';
 
 import { useRegisterInputEvents } from '@/object-record/record-field/meta-types/input/hooks/useRegisterInputEvents';
-import { CountryPickerDropdownButton } from '@/ui/input/components/internal/phone/components/CountryPickerDropdownButton';
+import { PhoneCountryPickerDropdownButton } from '@/ui/input/components/internal/phone/components/PhoneCountryPickerDropdownButton';
 
 import 'react-phone-number-input/style.css';
 
@@ -102,7 +102,7 @@ export const PhoneInput = ({
         onChange={handleChange}
         international={true}
         withCountryCallingCode={true}
-        countrySelectComponent={CountryPickerDropdownButton}
+        countrySelectComponent={PhoneCountryPickerDropdownButton}
       />
     </StyledContainer>
   );

packages/twenty-front/src/modules/ui/field/input/components/TextInput.tsx

@@ -4,7 +4,7 @@ import styled from '@emotion/styled';
 import { useRegisterInputEvents } from '@/object-record/record-field/meta-types/input/hooks/useRegisterInputEvents';
 import { TEXT_INPUT_STYLE } from '@/ui/theme/constants/TextInputStyle';
 
-export const StyledInput = styled.input`
+export const StyledTextInput = styled.input`
   margin: 0;
   ${TEXT_INPUT_STYLE}
   width: 100%;
@@ -60,7 +60,7 @@ export const TextInput = ({
   });
 
   return (
-    <StyledInput
+    <StyledTextInput
       autoComplete="off"
       ref={wrapperRef}
       placeholder={placeholder}