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

fix(VisuallyHidden): remove flex support #3219

Merged
merged 1 commit into from
Jan 12, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@
title: 'VisuallyHidden'
description: 'VisuallyHidden has all the styles necessary to hide it from visual clients, but keep it for screen readers.'
showTabs: true
hideTabs:
- title: Events
theme: 'sbanken'
---

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ When a element or component was given, that does not support spacing, it will st

You may else wrap your custom component in a `Flex.Item` – this way, you still can change the spacing per component basis.

Technically, `Flex.Container` checks if a nested component has a property called `_supportsSpacingProps`. So if you have a component that supports the [spacing properties](/uilib/layout/space/), you can add this property `ComponentName._supportsSpacingProps = true`.
Technically, `Flex.Container` checks if a nested component has a property called `_supportsSpacingProps`. So if you have a component that supports the [spacing properties](/uilib/layout/space/), you can add this property `ComponentName._supportsSpacingProps = true`. If you provide `false`, it will not support spacing.

If the component is a wrapper component, and you want its children to support spacing, you can add this property `ComponentName._supportsSpacingProps = 'children'`.

Expand Down
7 changes: 7 additions & 0 deletions packages/dnb-eufemia/src/components/flex/Container.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -161,6 +161,13 @@ function FlexContainer(props: Props) {
spacing
}

if (
React.isValidElement(previousChild) &&
previousChild?.type?.['_supportsSpacingProps'] === false
) {
startSpacing = 0
}

const space =
direction === 'horizontal'
? { [start]: endSpacing, [end]: startSpacing }
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -366,16 +366,16 @@ describe('Flex.Container', () => {
const elements = document.querySelectorAll(
'.dnb-flex-container > div'
)
expect(elements[0].className).toBe(
expect(elements[0]).toHaveClass(
'dnb-space dnb-space__top--zero dnb-space__bottom--zero'
)
expect(elements[1].className).toBe(
expect(elements[1]).toHaveClass(
'dnb-space dnb-space__top--small dnb-space__bottom--zero'
)
expect((elements[0].firstChild as HTMLElement).className).toBe(
expect(elements[0].firstChild as HTMLElement).toHaveClass(
'test-item'
)
expect((elements[1].firstChild as HTMLElement).className).toBe(
expect(elements[1].firstChild as HTMLElement).toHaveClass(
'dnb-space__bottom--large test-item'
)
}
Expand All @@ -393,15 +393,36 @@ describe('Flex.Container', () => {
const elements = document.querySelectorAll(
'.dnb-flex-container > div'
)
expect(elements[0].className).toBe(
expect(elements[0]).toHaveClass(
'dnb-space__top--zero dnb-space__bottom--zero test-item'
)
expect(elements[1].className).toBe(
expect(elements[1]).toHaveClass(
'dnb-space__bottom--x-large dnb-space__top--small test-item'
)
expect((elements[0].firstChild as HTMLElement).className).toBeFalsy()
expect((elements[1].firstChild as HTMLElement).className).toBeFalsy()
}

{
TestComponent._supportsSpacingProps = false

rerender(
<Flex.Vertical>
<TestComponent />
<TestComponent bottom="x-large" />
</Flex.Vertical>
)

const elements = document.querySelectorAll(
'.dnb-flex-container > div'
)
expect(elements[0]).toHaveClass('test-item')
expect(elements[1]).toHaveClass(
'dnb-space__bottom--x-large test-item'
)
expect((elements[0].firstChild as HTMLElement).className).toBeFalsy()
expect((elements[1].firstChild as HTMLElement).className).toBeFalsy()
}
})

it('should transform children if _supportsSpacingProps="children" is given', () => {
Expand Down Expand Up @@ -431,12 +452,10 @@ describe('Flex.Container', () => {
'.dnb-flex-container > div'
)
expect(elements).toHaveLength(1)
expect(elements[0].className).toBe(
expect(elements[0]).toHaveClass(
'dnb-space dnb-space__top--zero dnb-space__bottom--zero'
)
expect((elements[0].firstChild as HTMLElement).className).toBe(
'wrapper'
)
expect(elements[0].firstChild as HTMLElement).toHaveClass('wrapper')
}

{
Expand Down
21 changes: 16 additions & 5 deletions packages/dnb-eufemia/src/components/flex/utils.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -56,11 +56,18 @@ export const isEufemiaElement = (element): boolean => {
export const isSpacePropsComponent = (
element: React.ReactNode
): boolean => {
return (
(React.isValidElement(element) &&
element?.type?.['_supportsSpacingProps'] === true) ||
isEufemiaElement(element)
)
if (
React.isValidElement(element) &&
typeof element?.type?.['_supportsSpacingProps'] === 'boolean'
) {
return element?.type?.['_supportsSpacingProps']
}

if (isEufemiaElement(element)) {
return true
}

return undefined
}

export const renderWithSpacing = (
Expand All @@ -69,6 +76,10 @@ export const renderWithSpacing = (
) => {
const takesSpaceProps = isSpacePropsComponent(element)

if (takesSpaceProps === false) {
return element
}

return takesSpaceProps ? (
React.cloneElement(element as React.ReactElement<unknown>, props)
) : (
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,6 @@ const VisuallyHidden = (localProps: VisuallyHiddenAllProps) => {
)
}

VisuallyHidden._supportsSpacingProps = true
VisuallyHidden._supportsSpacingProps = false

export default VisuallyHidden
Loading