Skip to content

The open alternative to Salesforce, designed for AI.

Show example values as placeholders for simple fields in the record creation form (#28116)

Thomas Trompettec58a7d28df50
diff --git a/packages/twenty-front/src/modules/object-record/record-form/components/RecordFormFieldInputs.tsx b/packages/twenty-front/src/modules/object-record/record-form/components/RecordFormFieldInputs.tsx
index b57945a7c4e..eda4c0362f3 100644
--- a/packages/twenty-front/src/modules/object-record/record-form/components/RecordFormFieldInputs.tsx
+++ b/packages/twenty-front/src/modules/object-record/record-form/components/RecordFormFieldInputs.tsx
@@ -6,6 +6,7 @@ import { FormFieldInput } from '@/object-record/record-field/ui/components/FormF
import { RecordFormFieldInputsEffect } from '@/object-record/record-form/components/RecordFormFieldInputsEffect';
import { getRecordFormCurrencyFieldDefaultValue } from '@/object-record/record-form/utils/getRecordFormCurrencyFieldDefaultValue';
import { getRecordFormFieldInputSettings } from '@/object-record/record-form/utils/getRecordFormFieldInputSettings';
+import { getRecordFormFieldPlaceholders } from '@/object-record/record-form/utils/getRecordFormFieldPlaceholders';
import { type ObjectRecord } from '@/object-record/types/ObjectRecord';
import { type ValidationRuleViolation } from '@/validation-rules/types/ValidationRuleViolation';
import { styled } from '@linaria/react';
@@ -50,6 +51,9 @@ export const RecordFormFieldInputs = ({
{fieldMetadataItems.map((fieldMetadataItem) => {
const gqlFieldName =
getFieldMetadataItemGqlFieldName(fieldMetadataItem);
+ const { placeholder } = getRecordFormFieldPlaceholders(
+ fieldMetadataItem.type,
+ );
return (
<Field.Root key={fieldMetadataItem.id}>
@@ -69,6 +73,7 @@ export const RecordFormFieldInputs = ({
settings={getRecordFormFieldInputSettings(
fieldMetadataItem.type,
)}
+ placeholder={placeholder}
/>
{(
validationRuleViolationsByFieldMetadataId[
diff --git a/packages/twenty-front/src/modules/object-record/record-form/utils/__tests__/getRecordFormFieldPlaceholders.test.ts b/packages/twenty-front/src/modules/object-record/record-form/utils/__tests__/getRecordFormFieldPlaceholders.test.ts
new file mode 100644
index 00000000000..f91c0d08a38
--- /dev/null
+++ b/packages/twenty-front/src/modules/object-record/record-form/utils/__tests__/getRecordFormFieldPlaceholders.test.ts
@@ -0,0 +1,25 @@
+import { getRecordFormFieldPlaceholders } from '@/object-record/record-form/utils/getRecordFormFieldPlaceholders';
+import { FieldMetadataType } from '~/generated-metadata/graphql';
+
+describe('getRecordFormFieldPlaceholders', () => {
+ it('should use the example value of simple fields as their placeholder', () => {
+ expect(getRecordFormFieldPlaceholders(FieldMetadataType.NUMBER)).toEqual({
+ placeholder: '2000',
+ });
+ expect(getRecordFormFieldPlaceholders(FieldMetadataType.UUID)).toEqual({
+ placeholder: '00000000-0000-4000-8000-000000000000',
+ });
+ expect(getRecordFormFieldPlaceholders(FieldMetadataType.RAW_JSON)).toEqual({
+ placeholder: '{"key":"value1"}',
+ });
+ });
+
+ it.each([
+ FieldMetadataType.TEXT,
+ FieldMetadataType.SELECT,
+ FieldMetadataType.DATE,
+ FieldMetadataType.RELATION,
+ ])('should keep the default placeholders of %s fields', (fieldType) => {
+ expect(getRecordFormFieldPlaceholders(fieldType)).toEqual({});
+ });
+});
diff --git a/packages/twenty-front/src/modules/object-record/record-form/utils/getRecordFormFieldPlaceholders.ts b/packages/twenty-front/src/modules/object-record/record-form/utils/getRecordFormFieldPlaceholders.ts
new file mode 100644
index 00000000000..8d467db5569
--- /dev/null
+++ b/packages/twenty-front/src/modules/object-record/record-form/utils/getRecordFormFieldPlaceholders.ts
@@ -0,0 +1,36 @@
+import { SETTINGS_NON_COMPOSITE_FIELD_TYPE_CONFIGS } from '@/settings/data-model/constants/SettingsNonCompositeFieldTypeConfigs';
+import { isDefined } from 'twenty-shared/utils';
+import { FieldMetadataType } from '~/generated-metadata/graphql';
+
+type RecordFormFieldPlaceholders = {
+ placeholder?: string;
+};
+
+const getNonCompositeExampleValue = (
+ fieldType: keyof typeof SETTINGS_NON_COMPOSITE_FIELD_TYPE_CONFIGS,
+): unknown =>
+ SETTINGS_NON_COMPOSITE_FIELD_TYPE_CONFIGS[fieldType].exampleValues?.[0];
+
+export const getRecordFormFieldPlaceholders = (
+ fieldType: FieldMetadataType,
+): RecordFormFieldPlaceholders => {
+ switch (fieldType) {
+ case FieldMetadataType.NUMBER:
+ case FieldMetadataType.UUID: {
+ const exampleValue = getNonCompositeExampleValue(fieldType);
+
+ return isDefined(exampleValue)
+ ? { placeholder: String(exampleValue) }
+ : {};
+ }
+ case FieldMetadataType.RAW_JSON: {
+ const exampleValue = getNonCompositeExampleValue(fieldType);
+
+ return isDefined(exampleValue)
+ ? { placeholder: JSON.stringify(exampleValue) }
+ : {};
+ }
+ default:
+ return {};
+ }
+};