feat(FormBlock): add content labels, stub, update background (#1314)

* feat(FormBlock): add content labels, add stub

* chore: fix tests

* fix: label sizes

* feat: background-support

* fix: requsted changes

Author: PahaN47

memory-bank/usage/content.md

@@ -444,10 +444,11 @@ The Content component is composed of several key parts:
 
 1. **Title**: Displays the content title using the Title component
 2. **Text**: Displays the main text content using the YFMWrapper component
-3. **Content List**: Displays a list of content items using the ContentList component
-4. **Additional Info**: Displays additional information using the YFMWrapper component
-5. **Links**: Displays links using the Links component
-6. **Buttons**: Displays buttons using the Buttons component
+3. **Labels**: Displays labels using the ContentLabels component
+4. **Content List**: Displays a list of content items using the ContentList component
+5. **Additional Info**: Displays additional information using the YFMWrapper component
+6. **Links**: Displays links using the Links component
+7. **Buttons**: Displays buttons using the Buttons component
 
 ### Internal Structure
 
@@ -469,6 +470,11 @@ The Content component is composed of several key parts:
       />
     </div>
   )}
+  {labels?.length ? (
+    <div className={b('labels')}>
+      <ContentLabels labels={labels} theme={theme} />
+    </div>
+  ) : null}
   {list?.length ? (
     <div className={b('list')}>
       <ContentList list={list} size={size} qa={qaAttributes.list} theme={theme} />

src/blocks/Form/Form.scss

@@ -106,6 +106,7 @@ $largeBorderRadius: 32px;
         }
     }
 
+    $labelsBlock: '.#{$ns}content-labels';
     @media (min-width: map-get($gridBreakpoints, 'lg')) {
         &_form-type_yandex {
             #{$root}__row {
@@ -133,7 +134,7 @@ $largeBorderRadius: 32px;
         }
     }
 
-    @media (max-width: map-get($gridBreakpoints, 'lg')) and (min-width: map-get($gridBreakpoints, 'md')) {
+    @media (max-width: calc(map-get($gridBreakpoints, 'lg') - 1px)) and (min-width: map-get($gridBreakpoints, 'md')) {
         &__row {
             flex-direction: column;
         }
@@ -161,6 +162,10 @@ $largeBorderRadius: 32px;
                 #{$root}__content-wrapper {
                     text-align: center;
                     padding-bottom: $indentM;
+
+                    #{$labelsBlock} {
+                        justify-content: center;
+                    }
                 }
             }
         }
@@ -172,7 +177,7 @@ $largeBorderRadius: 32px;
         }
     }
 
-    @media (max-width: map-get($gridBreakpoints, 'md')) {
+    @media (max-width: calc(map-get($gridBreakpoints, 'md') - 1px)) {
         &__full-form {
             padding: $indentM;
         }

src/blocks/Form/Form.tsx

@@ -5,6 +5,7 @@ import InnerForm from '../../components/InnerForm/InnerForm';
 import {MobileContext} from '../../context/mobileContext';
 import {useTheme} from '../../context/theme';
 import {Col, Grid, GridAlignItems, GridColumnSize, Row} from '../../grid';
+import {useDeviceValue} from '../../hooks/useDeviceValue';
 import type {FormBlockProps} from '../../models';
 import {
     FormBlockDataTypes,
@@ -15,31 +16,42 @@ import {
 import {Content} from '../../sub-blocks';
 import {block, getThemedValue} from '../../utils';
 
+import {hasBackgroundCSS} from './utils';
+
 import './Form.scss';
 
 const b = block('form-block');
 
 const colSizes = {[GridColumnSize.Lg]: 6, [GridColumnSize.All]: 12};
 
 const Form = (props: FormBlockProps) => {
-    const {formData, title, textContent, direction = FormBlockDirection.Center, background} = props;
+    const {
+        formData,
+        title,
+        textContent,
+        direction = FormBlockDirection.Center,
+        background,
+        customFormNode,
+    } = props;
     const [contentLoaded, setContentLoaded] = React.useState(false);
     const isMobile = React.useContext(MobileContext);
     const theme = useTheme();
 
     const themedBackground = getThemedValue(background, theme) || undefined;
+    const themedBackgroundStyle = useDeviceValue(themedBackground?.style) || undefined;
 
     const withBackground = Boolean(
         themedBackground &&
             (themedBackground.src ||
                 themedBackground.desktop ||
-                themedBackground.style?.backgroundColor),
+                hasBackgroundCSS(themedBackgroundStyle ?? {})),
     );
+
     const onContentLoad = React.useCallback(() => {
         setContentLoaded(true);
     }, []);
 
-    if (!formData) {
+    if (!formData && !customFormNode) {
         return null;
     }
 
@@ -61,6 +73,7 @@ const Form = (props: FormBlockProps) => {
             {themedBackground && (
                 <BackgroundImage
                     {...themedBackground}
+                    style={themedBackgroundStyle}
                     className={b('media')}
                     imageClassName={b('image')}
                 />
@@ -96,21 +109,25 @@ const Form = (props: FormBlockProps) => {
                                     hidden: !contentLoaded,
                                 })}
                             >
-                                {title && (
-                                    <Title
-                                        title={{
-                                            text: title,
-                                            textSize: 's',
-                                        }}
-                                        className={b('title', {mobile: isMobile})}
-                                        colSizes={{all: 12}}
-                                    />
+                                {customFormNode || (
+                                    <React.Fragment>
+                                        {title && (
+                                            <Title
+                                                title={{
+                                                    text: title,
+                                                    textSize: 's',
+                                                }}
+                                                className={b('title', {mobile: isMobile})}
+                                                colSizes={{all: 12}}
+                                            />
+                                        )}
+                                        <InnerForm
+                                            className={b('form')}
+                                            formData={formData}
+                                            onContentLoad={onContentLoad}
+                                        />
+                                    </React.Fragment>
                                 )}
-                                <InnerForm
-                                    className={b('form')}
-                                    formData={formData}
-                                    onContentLoad={onContentLoad}
-                                />
                             </div>
                         </div>
                     </Col>

src/blocks/Form/__stories__/Form.mdx

@@ -17,6 +17,21 @@ import * as FormBlockStories from './Form.stories.tsx';
 
 `direction?: 'form-content' | 'content-form' | 'center'` - Direction.
 
-`background?: BackgroundImage` — See [background](?path=/docs/components-pics-video-datalens-backgroundimage--docs) properties.
+`background?: FormBlockBackgroundProps` — Same as `BackgroundImage` (see [background](?path=/docs/components-pics-video-datalens-backgroundimage--docs) properties), but the `style` prop supports `Device` breakpoints, for example:
+
+```ts
+{
+    style: {
+        desktop: {
+            background: 'red',
+        },
+        mobile: {
+            background: 'blue',
+        },
+    }
+}
+```
+
+`customFormNode?: React.ReactNode` - A custom React node that will be rendered instead of the form.
 
 </StoryTemplate>

src/blocks/Form/__stories__/Form.stories.tsx

@@ -5,6 +5,8 @@ import {blockTransform} from '../../../../.storybook/utils';
 import {FormBlockDirection, FormBlockModel, FormBlockProps} from '../../../models';
 import FormBlock from '../Form';
 
+import ExampleStub from './components/ExmapleStub';
+
 import data from './data.json';
 
 export default {
@@ -42,6 +44,7 @@ export const WithBackgroundColor = VariantsTemplate.bind([]);
 export const WithBackgroundImage = VariantsTemplate.bind([]);
 export const DarkTheme = VariantsTemplate.bind([]);
 export const FormData = VariantsTemplate.bind([]);
+export const WithCustomFormNode = DefaultTemplate.bind([]);
 
 Default.args = data.default as FormBlockModel;
 
@@ -88,3 +91,5 @@ FormData.parameters = {
         include: Object.keys(FormData.args),
     },
 };
+
+WithCustomFormNode.args = {...data.default, customFormNode: <ExampleStub />} as FormBlockModel;

src/blocks/Form/__stories__/components/ExmapleStub.tsx

@@ -0,0 +1,23 @@
+import {Button} from '@gravity-ui/uikit';
+
+const ExampleStub = () => {
+    return (
+        <div
+            style={{
+                display: 'flex',
+                flexDirection: 'column',
+                justifyContent: 'center',
+                alignItems: 'center',
+                gap: 24,
+            }}
+        >
+            <h1>This is an example form component</h1>
+            <p>It can be anything</p>
+            <Button size="xl" view="action">
+                Got it!
+            </Button>
+        </div>
+    );
+};
+
+export default ExampleStub;

src/blocks/Form/__tests__/Form.visual.test.tsx

@@ -7,6 +7,7 @@ import {
     FormData,
     WithBackgroundColor,
     WithBackgroundImage,
+    WithCustomFormNode,
 } from './helpers';
 
 const DEFAULT_FORM_DELAY = 20 * 1000;
@@ -48,4 +49,10 @@ test.describe('Form', () => {
         await delay(DEFAULT_FORM_DELAY);
         await expectScreenshot({skipTheme: 'dark'});
     });
+
+    test.skip('render stories <WithCustomFormNode>', async ({mount, expectScreenshot, delay}) => {
+        await mount(<WithCustomFormNode />);
+        await delay(DEFAULT_FORM_DELAY);
+        await expectScreenshot({skipTheme: 'dark'});
+    });
 });

src/blocks/Form/__tests__/helpers.tsx

@@ -9,4 +9,5 @@ export const {
     WithBackgroundImage,
     DarkTheme,
     FormData,
+    WithCustomFormNode,
 } = composeStories(FormStories);

src/blocks/Form/schema.ts

@@ -42,10 +42,7 @@ export const FormBlock = {
             direction: {
                 enum: ['content-form', 'form-content', 'center'],
             },
-            image: ImageProps,
-            backgroundColor: {
-                type: 'string',
-            },
+            background: ImageProps,
         },
     },
 };

src/blocks/Form/utils.ts

@@ -0,0 +1,19 @@
+import * as React from 'react';
+
+export const BACKGROUND_STYLE_PROPS = [
+    'background',
+    'backgroundAttachment',
+    'backgroundBlendMode',
+    'backgroundClip',
+    'backgroundColor',
+    'backgroundImage',
+    'backgroundOrigin',
+    'backgroundPositionX',
+    'backgroundPositionY',
+    'backgroundRepeat',
+    'backgroundSize',
+    'backgroundPosition',
+] as const;
+
+export const hasBackgroundCSS = (style: React.CSSProperties) =>
+    BACKGROUND_STYLE_PROPS.some((backgroundStyleProp) => backgroundStyleProp in style);