Skip to content

The open alternative to Salesforce, designed for AI.

Validation rule form (3/5): suggestion details like the design (#27092)

Thomas Trompette061ead542eca
diff --git a/packages/twenty-front/src/modules/validation-rules/components/SettingsValidationRuleExampleExpression.tsx b/packages/twenty-front/src/modules/validation-rules/components/SettingsValidationRuleExampleExpression.tsx
new file mode 100644
index 00000000000..ef1fa3dfdc6
--- /dev/null
+++ b/packages/twenty-front/src/modules/validation-rules/components/SettingsValidationRuleExampleExpression.tsx
@@ -0,0 +1,61 @@
+import { isDefined, isValidationRuleReservedName } from 'twenty-shared/utils';
+
+import { SettingsValidationRuleExpressionText } from '@/validation-rules/components/SettingsValidationRuleExpressionText';
+import { SettingsValidationRuleFieldChip } from '@/validation-rules/components/SettingsValidationRuleFieldChip';
+import { type ValidationRuleEditorField } from '@/validation-rules/types/ValidationRuleEditorField';
+import { computeValidationRuleEditorSegments } from '@/validation-rules/utils/computeValidationRuleEditorSegments';
+import { getValidationRuleEditorFieldChipLabel } from '@/validation-rules/utils/getValidationRuleEditorFieldChipLabel';
+
+type SettingsValidationRuleExampleExpressionProps = {
+ expression: string;
+ editorFields: ValidationRuleEditorField[];
+};
+
+export const SettingsValidationRuleExampleExpression = ({
+ expression,
+ editorFields,
+}: SettingsValidationRuleExampleExpressionProps) => {
+ const findEditorField = (path: string) => {
+ return editorFields.find((editorField) => editorField.path === path);
+ };
+
+ const segments = computeValidationRuleEditorSegments({
+ expression,
+ isFieldPath: (path) =>
+ !isValidationRuleReservedName({ name: path, isMember: false }) &&
+ isDefined(findEditorField(path)),
+ cursorOffset: null,
+ fieldRanges: [],
+ });
+
+ return (
+ <>
+ {segments.map((segment, index) => {
+ if (segment.type === 'text') {
+ return (
+ <SettingsValidationRuleExpressionText
+ key={index}
+ expression={segment.text}
+ />
+ );
+ }
+
+ const editorField = findEditorField(segment.path);
+
+ return isDefined(editorField) ? (
+ <SettingsValidationRuleFieldChip
+ key={index}
+ path={editorField.path}
+ label={getValidationRuleEditorFieldChipLabel(editorField)}
+ iconName={editorField.iconName}
+ />
+ ) : (
+ <SettingsValidationRuleExpressionText
+ key={index}
+ expression={segment.path}
+ />
+ );
+ })}
+ </>
+ );
+};
diff --git a/packages/twenty-front/src/modules/validation-rules/components/SettingsValidationRuleHelperDetails.tsx b/packages/twenty-front/src/modules/validation-rules/components/SettingsValidationRuleHelperDetails.tsx
index 7e07c1e2c54..a03b672e6e9 100644
--- a/packages/twenty-front/src/modules/validation-rules/components/SettingsValidationRuleHelperDetails.tsx
+++ b/packages/twenty-front/src/modules/validation-rules/components/SettingsValidationRuleHelperDetails.tsx
@@ -1,12 +1,13 @@
import { styled } from '@linaria/react';
import { useLingui } from '@lingui/react/macro';
+import { isDefined } from 'twenty-shared/utils';
import { useIcons } from 'twenty-ui/icon';
import { Tag } from 'twenty-ui/primitives/data-display';
import { themeCssVariables, useTheme } from 'twenty-ui/theme';
import { getSettingsFieldTypeConfig } from '@/settings/data-model/utils/getSettingsFieldTypeConfig';
import { isFieldTypeSupportedInSettings } from '@/settings/data-model/utils/isFieldTypeSupportedInSettings';
-import { SettingsValidationRuleExpressionText } from '@/validation-rules/components/SettingsValidationRuleExpressionText';
+import { SettingsValidationRuleExampleExpression } from '@/validation-rules/components/SettingsValidationRuleExampleExpression';
import { type ValidationRuleEditorField } from '@/validation-rules/types/ValidationRuleEditorField';
import { type ValidationRuleHelperItem } from '@/validation-rules/types/ValidationRuleHelperItem';
import { computeValidationRuleHelperItemExamples } from '@/validation-rules/utils/computeValidationRuleHelperItemExamples';
@@ -16,30 +17,42 @@ import { getValidationRuleHelperItemIcon } from '@/validation-rules/utils/getVal
const StyledDetails = styled.div`
display: flex;
flex-direction: column;
- gap: ${themeCssVariables.spacing[3]};
+ gap: ${themeCssVariables.spacing[2]};
min-width: 0;
overflow-y: auto;
padding: ${themeCssVariables.spacing[3]};
`;
+const StyledHeader = styled.div`
+ display: flex;
+ flex-direction: column;
+ gap: ${themeCssVariables.spacing[1]};
+ margin-bottom: ${themeCssVariables.spacing[1]};
+`;
+
+const StyledTitleRow = styled.div`
+ align-items: center;
+ display: flex;
+ gap: ${themeCssVariables.spacing[2]};
+ justify-content: space-between;
+`;
+
const StyledTitle = styled.div`
align-items: center;
color: ${themeCssVariables.font.color.primary};
display: flex;
font-weight: ${themeCssVariables.font.weight.medium};
- gap: ${themeCssVariables.spacing[2]};
+ gap: ${themeCssVariables.spacing[1]};
+ min-width: 0;
`;
const StyledSignature = styled.span`
font-family: ${themeCssVariables.code.font.family};
`;
-const StyledMeta = styled.div`
- align-items: center;
- color: ${themeCssVariables.font.color.tertiary};
- display: flex;
- flex-wrap: wrap;
- gap: ${themeCssVariables.spacing[2]};
+const StyledSubtitle = styled.div`
+ color: ${themeCssVariables.font.color.light};
+ font-size: ${themeCssVariables.font.size.sm};
`;
const StyledDescription = styled.div`
@@ -47,16 +60,11 @@ const StyledDescription = styled.div`
line-height: 1.5;
`;
-const StyledExamplesTitle = styled.div`
- color: ${themeCssVariables.font.color.light};
- font-size: ${themeCssVariables.font.size.xs};
- font-weight: ${themeCssVariables.font.weight.semiBold};
-`;
-
const StyledExample = styled.div`
background: ${themeCssVariables.background.transparent.lighter};
border: 1px solid ${themeCssVariables.border.color.light};
border-radius: ${themeCssVariables.border.radius.sm};
+ line-height: 24px;
padding: ${themeCssVariables.spacing[1]} ${themeCssVariables.spacing[2]};
`;
@@ -88,7 +96,7 @@ export const SettingsValidationRuleHelperDetails = ({
/>
);
- const renderSummary = () => {
+ const renderHeader = () => {
switch (item.kind) {
case 'field': {
const typeLabel = isFieldTypeSupportedInSettings(item.field.type)
@@ -99,24 +107,19 @@ export const SettingsValidationRuleHelperDetails = ({
return (
<>
- <StyledTitle>
- {itemIcon}
- {getValidationRuleEditorFieldChipLabel(item.field)}
- </StyledTitle>
- <StyledMeta>
- {t`${typeLabel} field`}
+ <StyledTitleRow>
+ <StyledTitle>
+ {itemIcon}
+ {getValidationRuleEditorFieldChipLabel(item.field)}
+ </StyledTitle>
<Tag
- color="gray"
+ color="blue"
startIcon={<ObjectIcon size={theme.icon.size.sm} />}
>
{item.field.objectLabelSingular}
</Tag>
- </StyledMeta>
- {item.field.readsRelatedRecord && (
- <StyledDescription>
- {t`Checked only when the record this rule belongs to is saved. Editing the related record does not check it again.`}
- </StyledDescription>
- )}
+ </StyledTitleRow>
+ <StyledSubtitle>{t`${typeLabel} field`}</StyledSubtitle>
</>
);
}
@@ -128,30 +131,40 @@ export const SettingsValidationRuleHelperDetails = ({
{itemIcon}
<StyledSignature>{item.definition.signature}</StyledSignature>
</StyledTitle>
- <StyledMeta>
+ <StyledSubtitle>
{item.kind === 'function' ? t`Function` : t`Keyword`}
- </StyledMeta>
- <StyledDescription>
- {t(item.definition.description)}
- </StyledDescription>
+ </StyledSubtitle>
</>
);
}
};
+ const getDescription = () => {
+ if (item.kind !== 'field') {
+ return t(item.definition.description);
+ }
+
+ return item.field.readsRelatedRecord
+ ? t`Checked only when the record this rule belongs to is saved. Editing the related record does not check it again.`
+ : undefined;
+ };
+
+ const description = getDescription();
+
return (
<StyledDetails>
- {renderSummary()}
- {examples.length > 0 && (
- <>
- <StyledExamplesTitle>{t`Examples`}</StyledExamplesTitle>
- {examples.map((example) => (
- <StyledExample key={example}>
- <SettingsValidationRuleExpressionText expression={example} />
- </StyledExample>
- ))}
- </>
+ <StyledHeader>{renderHeader()}</StyledHeader>
+ {isDefined(description) && (
+ <StyledDescription>{description}</StyledDescription>
)}
+ {examples.map((example) => (
+ <StyledExample key={example}>
+ <SettingsValidationRuleExampleExpression
+ expression={example}
+ editorFields={editorFields}
+ />
+ </StyledExample>
+ ))}
</StyledDetails>
);
};