-
Notifications
You must be signed in to change notification settings - Fork 843
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
[Emotion] Add internal service for cloning elements with the css
property
#5835
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,105 @@ | ||
/* | ||
* Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one | ||
* or more contributor license agreements. Licensed under the Elastic License | ||
* 2.0 and the Server Side Public License, v 1; you may not use this file except | ||
* in compliance with, at your election, the Elastic License 2.0 or the Server | ||
* Side Public License, v 1. | ||
*/ | ||
|
||
/** @jsx jsx */ | ||
import React from 'react'; | ||
import { css, jsx } from '@emotion/react'; | ||
import { render } from 'enzyme'; | ||
|
||
import { cloneElementWithCss } from './clone_element'; | ||
|
||
describe('cloneElementWithCss', () => { | ||
const CloningParent: React.FC<any> = ({ children, ...props }) => { | ||
return cloneElementWithCss(children, props); | ||
}; | ||
|
||
it('correctly renders css on elements that do not already have a `css` property', () => { | ||
const component = render( | ||
<CloningParent css={{ color: 'red' }}> | ||
<div>hello world</div> | ||
</CloningParent> | ||
); | ||
|
||
expect(component).toMatchInlineSnapshot(` | ||
<div | ||
class="css-1h3ogp1-component" | ||
> | ||
hello world | ||
</div> | ||
`); | ||
expect(component).toHaveStyleRule('color', 'red'); | ||
}); | ||
|
||
it('combines css properties on cloned elements that already have a `css` property', () => { | ||
const component = render( | ||
<CloningParent css={{ color: 'red' }}> | ||
<div | ||
css={[ | ||
css` | ||
background-color: blue; | ||
`, | ||
]} | ||
> | ||
hello world | ||
</div> | ||
</CloningParent> | ||
); | ||
|
||
expect(component).toMatchInlineSnapshot(` | ||
<div | ||
class="css-88aly5-component-component-component" | ||
> | ||
hello world | ||
</div> | ||
`); | ||
expect(component).toHaveStyleRule('color', 'red'); | ||
expect(component).toHaveStyleRule('background-color', 'blue'); | ||
}); | ||
|
||
it('handles components', () => { | ||
const TestComponent: React.FC = (props) => ( | ||
<div {...props} css={{ backgroundColor: 'blue' }}> | ||
hello world | ||
</div> | ||
); | ||
|
||
const component = render( | ||
<CloningParent css={{ color: 'red' }}> | ||
<TestComponent css={{ border: '1px solid black' }} /> | ||
</CloningParent> | ||
); | ||
|
||
expect(component).toMatchInlineSnapshot(` | ||
<div | ||
class="css-1fcrfq4-TestComponent-component-component" | ||
> | ||
hello world | ||
</div> | ||
`); | ||
expect(component).toHaveStyleRule('color', 'red'); | ||
expect(component).toHaveStyleRule('background-color', 'blue'); | ||
expect(component).toHaveStyleRule('border', '1px solid black'); | ||
}); | ||
|
||
it('does nothing if no css property is set', () => { | ||
const component = render( | ||
<CloningParent className="test"> | ||
<div>hello world</div> | ||
</CloningParent> | ||
); | ||
|
||
expect(component).toMatchInlineSnapshot(` | ||
<div | ||
class="test" | ||
> | ||
hello world | ||
</div> | ||
`); | ||
expect(component).not.toHaveStyleRule('color', 'red'); | ||
}); | ||
}); |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,38 @@ | ||
/* | ||
* Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one | ||
* or more contributor license agreements. Licensed under the Elastic License | ||
* 2.0 and the Server Side Public License, v 1; you may not use this file except | ||
* in compliance with, at your election, the Elastic License 2.0 or the Server | ||
* Side Public License, v 1. | ||
*/ | ||
|
||
import React from 'react'; | ||
import { jsx } from '@emotion/react'; | ||
|
||
/** | ||
* React.cloneElement does not work if the cloned element does not already have the | ||
* `css` prop - as a result, we need to use `jsx()` to manually clone the element | ||
* See https://github.com/emotion-js/emotion/issues/1404 | ||
* | ||
* NOTE: We're still using/testing this utility internally, so this is not yet a public API | ||
*/ | ||
export const cloneElementWithCss = ( | ||
element: any, | ||
props: any | ||
): React.ReactElement => { | ||
const clonedElement = | ||
element.props.__EMOTION_TYPE_PLEASE_DO_NOT_USE__ || element.type; // EMOTION_TYPE handles non-React elements (native JSX/HTML nodes) | ||
|
||
const clonedProps = { | ||
key: element.key, | ||
ref: element.ref, | ||
...element.props, | ||
...props, | ||
}; | ||
|
||
if (props.css || element.props.css) { | ||
clonedProps.css = [element.props.css, props.css]; | ||
} | ||
Comment on lines
+33
to
+35
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. this doesn't seem to be necessary from my unit testing, There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. This code does have an impact based on my testing. Given <EuiScreenReaderOnly
css={css`
color: coral;
`}
>
<p
css={css`
background-color: gainsboro;
`}
>
This is the second paragraph. It is hidden for sighted users but visible
to screen readers.
</p>
</EuiScreenReaderOnly> Without this code, There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Super baffling - I can't seem to reproduce this behavior in the unit tests in this PR. I'm not exactly sure what the difference is between EuiScreenReaderOnly and Jest/JSDOM. If it works for you though no worries, let's leave it in! |
||
|
||
return jsx(clonedElement, clonedProps); | ||
}; |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Not super in love with this name or anything, would be open to other suggestions/preferences, e.g.
emotionClone