Skip to content

feat(Flex): add gap support #9122

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.

Sign up for GitHub

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

Merged
merged 3 commits into from
May 17, 2023
Merged

feat(Flex): add gap support #9122

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
d2062d1
feat(Flex): add gap support
kmcfaul May 15, 2023
0d64a7a
update docs, prop desc
kmcfaul May 16, 2023
64dcdf9
add blurb
kmcfaul May 16, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
141 changes: 141 additions & 0 deletions packages/react-core/src/layouts/Flex/Flex.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -136,6 +136,141 @@ export interface FlexProps extends React.HTMLProps<HTMLDivElement> {
| 'spaceItems3xl'
| 'spaceItems4xl';
};
/** Gap between items at various breakpoints. This will override spacers for the main axis. */
gap?: {
default?: 'gapNone' | 'gapXs' | 'gapSm' | 'gapMd' | 'gapLg' | 'gapXl' | 'gap2xl' | 'gap3xl' | 'gap4xl';
sm?: 'gapNone' | 'gapXs' | 'gapSm' | 'gapMd' | 'gapLg' | 'gapXl' | 'gap2xl' | 'gap3xl' | 'gap4xl';
md?: 'gapNone' | 'gapXs' | 'gapSm' | 'gapMd' | 'gapLg' | 'gapXl' | 'gap2xl' | 'gap3xl' | 'gap4xl';
lg?: 'gapNone' | 'gapXs' | 'gapSm' | 'gapMd' | 'gapLg' | 'gapXl' | 'gap2xl' | 'gap3xl' | 'gap4xl';
xl?: 'gapNone' | 'gapXs' | 'gapSm' | 'gapMd' | 'gapLg' | 'gapXl' | 'gap2xl' | 'gap3xl' | 'gap4xl';
'2xl'?: 'gapNone' | 'gapXs' | 'gapSm' | 'gapMd' | 'gapLg' | 'gapXl' | 'gap2xl' | 'gap3xl' | 'gap4xl';
};
/** Gap between rows at various breakpoints. This will override spacers for the main axis. */
rowGap?: {
default?:
| 'rowGapNone'
| 'rowGapXs'
| 'rowGapSm'
| 'rowGapMd'
| 'rowGapLg'
| 'rowGapXl'
| 'rowGap2xl'
| 'rowGap3xl'
| 'rowGap4xl';
sm?:
| 'rowGapNone'
| 'rowGapXs'
| 'rowGapSm'
| 'rowGapMd'
| 'rowGapLg'
| 'rowGapXl'
| 'rowGap2xl'
| 'rowGap3xl'
| 'rowGap4xl';
md?:
| 'rowGapNone'
| 'rowGapXs'
| 'rowGapSm'
| 'rowGapMd'
| 'rowGapLg'
| 'rowGapXl'
| 'rowGap2xl'
| 'rowGap3xl'
| 'rowGap4xl';
lg?:
| 'rowGapNone'
| 'rowGapXs'
| 'rowGapSm'
| 'rowGapMd'
| 'rowGapLg'
| 'rowGapXl'
| 'rowGap2xl'
| 'rowGap3xl'
| 'rowGap4xl';
xl?:
| 'rowGapNone'
| 'rowGapXs'
| 'rowGapSm'
| 'rowGapMd'
| 'rowGapLg'
| 'rowGapXl'
| 'rowGap2xl'
| 'rowGap3xl'
| 'rowGap4xl';
'2xl'?:
| 'rowGapNone'
| 'rowGapXs'
| 'rowGapSm'
| 'rowGapMd'
| 'rowGapLg'
| 'rowGapXl'
| 'rowGap2xl'
| 'rowGap3xl'
| 'rowGap4xl';
};
/** Gap beween columns at various breakpoints. This will override spacers for the main axis. */
columnGap?: {
default?:
| 'columnGapNone'
| 'columnGapXs'
| 'columnGapSm'
| 'columnGapMd'
| 'columnGapLg'
| 'columnGapXl'
| 'columnGap2xl'
| 'columnGap3xl'
| 'columnGap4xl';
sm?:
| 'columnGapNone'
| 'columnGapXs'
| 'columnGapSm'
| 'columnGapMd'
| 'columnGapLg'
| 'columnGapXl'
| 'columnGap2xl'
| 'columnGap3xl'
| 'columnGap4xl';
md?:
| 'columnGapNone'
| 'columnGapXs'
| 'columnGapSm'
| 'columnGapMd'
| 'columnGapLg'
| 'columnGapXl'
| 'columnGap2xl'
| 'columnGap3xl'
| 'columnGap4xl';
lg?:
| 'columnGapNone'
| 'columnGapXs'
| 'columnGapSm'
| 'columnGapMd'
| 'columnGapLg'
| 'columnGapXl'
| 'columnGap2xl'
| 'columnGap3xl'
| 'columnGap4xl';
xl?:
| 'columnGapNone'
| 'columnGapXs'
| 'columnGapSm'
| 'columnGapMd'
| 'columnGapLg'
| 'columnGapXl'
| 'columnGap2xl'
| 'columnGap3xl'
| 'columnGap4xl';
'2xl'?:
| 'columnGapNone'
| 'columnGapXs'
| 'columnGapSm'
| 'columnGapMd'
| 'columnGapLg'
| 'columnGapXl'
| 'columnGap2xl'
| 'columnGap3xl'
| 'columnGap4xl';
};
/** Whether to add flex: grow at various breakpoints */
grow?: {
default?: 'grow';
Expand Down Expand Up @@ -344,6 +479,9 @@ export const Flex: React.FunctionComponent<FlexProps> = ({
component = 'div',
spacer,
spaceItems,
gap,
rowGap,
columnGap,
grow,
shrink,
flex,
Expand Down Expand Up @@ -380,6 +518,9 @@ export const Flex: React.FunctionComponent<FlexProps> = ({
formatBreakpointMods(display, styles),
formatBreakpointMods(fullWidth, styles),
formatBreakpointMods(flexWrap, styles),
formatBreakpointMods(gap, styles),
formatBreakpointMods(rowGap, styles),
formatBreakpointMods(columnGap, styles),
className
)}
style={
Expand Down
40 changes: 30 additions & 10 deletions packages/react-core/src/layouts/Flex/__tests__/Flex.test.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -85,36 +85,56 @@ describe('Flex', () => {
],
display: ['inlineFlex'],
fullWidth: ['fullWidth'],
flexWrap: ['wrap', 'wrapReverse', 'nowrap']
flexWrap: ['wrap', 'wrapReverse', 'nowrap'],
gap: ['gapNone', 'gapXs', 'gapSm', 'gapMd', 'gapLg', 'gapXl', 'gap2xl', 'gap3xl', 'gap4xl'],
rowGap: [
'rowGapNone',
'rowGapXs',
'rowGapSm',
'rowGapMd',
'rowGapLg',
'rowGapXl',
'rowGap2xl',
'rowGap3xl',
'rowGap4xl'
],
columnGap: [
'columnGapNone',
'columnGapXs',
'columnGapSm',
'columnGapMd',
'columnGapLg',
'columnGapXl',
'columnGap2xl',
'columnGap3xl',
'columnGap4xl'
]
};

describe('flex modifiers', () => {
Object.entries(flexModifiers)
.map(([mod, values]) =>
values.map(value => ({
values.map((value) => ({
[mod]: {
default: value,
sm: value,
md: value,
lg: value,
xl: value,
'2xl': value
}
}))
)
.reduce((acc, val) => acc.concat(val), [])
.forEach(props =>
.forEach((props) =>
test(`${JSON.stringify(props)} add valid classes to Flex`, () => {
render(
<Flex {...props} data-testid="test-id">
{JSON.stringify(props)}
</Flex>
);

const className = screen
.getByTestId('test-id')
.className.replace('pf-l-flex', '')
.trim();

const className = screen.getByTestId('test-id').className.replace('pf-l-flex', '').trim();
expect(className).not.toBe("''");
expect(className).not.toBe('');
})
Expand All @@ -134,7 +154,7 @@ describe('Flex', () => {
describe('flexItem modifiers', () => {
Object.entries(flexItemModifiers)
.map(([mod, values]) =>
values.map(value => ({
values.map((value) => ({
[mod]: {
default: value,
sm: value,
Expand All @@ -145,7 +165,7 @@ describe('Flex', () => {
}))
)
.reduce((acc, val) => acc.concat(val), [])
.forEach(props =>
.forEach((props) =>
test(`${JSON.stringify(props)} add valid classes to FlexItem`, () => {
render(
<FlexItem {...props} data-testid="test-id">
Expand Down
Loading