Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

tech(Flex): add support flex with gap #8212

Merged
merged 12 commits into from
Feb 3, 2025
38 changes: 25 additions & 13 deletions packages/vkui/src/components/Flex/Flex.module.css
Original file line number Diff line number Diff line change
Expand Up @@ -13,13 +13,31 @@
margin-block: var(--vkui--size_base_padding_vertical--regular);
}

.withGaps {
margin-block-start: calc(
-1 * var(--vkui_internal--row_gap) + var(--vkui_internal--flex_original_margin_block)
);
margin-inline-start: calc(
-1 * var(--vkui_internal--column_gap) + var(--vkui_internal--flex_original_margin_inline)
);
/*TODO [>=8]: Проверить браузерную поддержку gap*/
/*Данная проверка позволяет максимально близко определить поддерживается ли gap + flex*/
/*см. https://github.com/w3c/csswg-drafts/issues/3559#issuecomment-1758459996*/
/*Поддержка inset https://developer.mozilla.org/en-US/docs/Web/CSS/inset#browser_compatibility*/
/*Поддержка gap https://developer.mozilla.org/en-US/docs/Web/CSS/gap#browser_compatibility*/
@supports (inset: 0) {
.host {
gap: var(--vkui_internal--row_gap) var(--vkui_internal--column_gap);
}
}
@supports not (inset: 0) {
.withGaps {
margin-block-start: calc(
-1 * var(--vkui_internal--row_gap) + var(--vkui_internal--flex_original_margin_block)
);
margin-inline-start: calc(
-1 * var(--vkui_internal--column_gap) + var(--vkui_internal--flex_original_margin_inline)
);
}

/* stylelint-disable-next-line @project-tools/stylelint-atomic, selector-max-universal */
.withGaps.withGaps > * {
margin-block-start: var(--vkui_internal--row_gap);
margin-inline-start: var(--vkui_internal--column_gap);
}
}

.host > .marginAuto {
Expand Down Expand Up @@ -90,9 +108,3 @@
.alignBaseline {
align-items: baseline;
}

/* stylelint-disable-next-line @project-tools/stylelint-atomic, selector-max-universal */
.withGaps.withGaps > * {
margin-block-start: var(--vkui_internal--row_gap);
margin-inline-start: var(--vkui_internal--column_gap);
}
40 changes: 35 additions & 5 deletions packages/vkui/src/components/Flex/Flex.stories.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -7,24 +7,54 @@ import { Button } from '../Button/Button';
import { Image } from '../Image/Image';
import { Flex, type FlexProps } from './Flex';

const story: Meta<FlexProps> = {
type StoryProps = FlexProps & {
/**
* Отступ между строками
*/
rowGap?: number;
/**
* Отступ между столбцами
*/
columnGap?: number;
/**
* Количество элементов
*/
itemsCount?: number;
};

const story: Meta<StoryProps> = {
title: 'Layout/Flex',
component: Flex,
parameters: { ...CanvasFullLayout, ...DisableCartesianParam },
argTypes: {
rowGap: {
control: 'number',
},
columnGap: {
control: 'number',
},
itemsCount: {
control: 'number',
},
},
};

export default story;

type Story = StoryObj<FlexProps>;
type Story = StoryObj<StoryProps>;

export const Playground: Story = {
args: {
gap: 'm',
itemsCount: 2,
style: { height: '100%' },
},
render: (args) => (
<Flex {...args}>
{Array.from({ length: 2 }, (_, index) => {
render: ({ itemsCount = 2, rowGap, columnGap, gap, ...args }) => (
<Flex
gap={rowGap !== undefined || columnGap !== undefined ? [rowGap || 0, columnGap || 0] : gap}
{...args}
>
{Array.from({ length: itemsCount }, (_, index) => {
return (
<Banner
key={index}
Expand Down
2 changes: 1 addition & 1 deletion packages/vkui/src/components/Flex/Flex.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,7 @@ export const Flex: React.FC<FlexProps> & {
...props
}: FlexProps) => {
const withGaps = Children.count(children) > 1 && gap;
const [rowGap, columnGap] = calculateGap(withGaps ? gap : undefined);
const [rowGap, columnGap] = calculateGap(gap);

return (
<RootComponent
Expand Down
25 changes: 25 additions & 0 deletions packages/vkui/src/components/Flex/Readme.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,30 @@
Базовый компонент для позиционирования элементов. Построен на базе `flex layout`.

> ⚠️ Важно: в версиях браузеров `Chrome >= 87`, `Edge >= 87`, `Safari >= 14.1`, `Firefox >= 66`, `Opera >= 73` при использовании
> свойства `gap` используется нативное CSS свойство `gap`. В версиях браузеров ниже используется fallback логика с использованием свойства `margin`.
>
> В связи с этим рекомендация по коду, если вы поддерживаете браузеры, которые не поддерживают `gap` на `flex` контейнерах:
>
> Избегайте использования `React.Fragment` в качестве `children`. Например, следующий кейс будет работать некорректно - у него не сработает `gap`:
>
> ```jsx static
> <Flex gap="m">
> <React.Fragment>
> <div>1</div>
> <div>2</div>
> </React.Fragment>
> </Flex>
> ```
>
> Нужно, чтобы у Flex было несколько непосредственных потомков:
>
> ```jsx static
> <Flex gap="m">
> <div>1</div>
> <div>2</div>
> </Flex>
> ```

```jsx { "props": { "layout": false, "iframe": false } }
const FlexContainer = ({ itemsCount, ...props }) => {
return (
Expand Down