Styled API #1094
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,2 @@ | ||
| declare function describe(string, Function): void | ||
| declare function it(string, Function): void |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,47 @@ | ||
| // @flow | ||
| /* eslint-disable react/prop-types, react/require-default-props */ | ||
|
|
||
| import React from 'react' | ||
| import isPropValid from '@emotion/is-prop-valid' | ||
| import type {StatelessFunctionalComponent, ComponentType} from 'react' | ||
| import withStyles from './withStyles' | ||
| import type {Options, Style, Classes} from './types' | ||
|
|
||
| // Props we don't want to forward. | ||
| const reservedProps = { | ||
| classes: true, | ||
| as: true, | ||
| theme: true | ||
| } | ||
|
|
||
| type StyledProps = { | ||
| className?: string, | ||
| as?: string, | ||
| classes?: Classes | ||
| } | ||
|
|
||
| export default <Props: {}>( | ||
| type: string | StatelessFunctionalComponent<Props> | ComponentType<Props> | ||
| ) => { | ||
| const isTag = typeof type === 'string' | ||
|
|
||
| return <Theme: {}>(style: Style<Theme>, options?: Options<Theme>) => { | ||
| const Styled = (props: StyledProps) => { | ||
| const {classes, as, className} = props | ||
| const childProps: Props = ({}: any) | ||
| for (const prop in props) { | ||
| if (prop in reservedProps) continue | ||
| // We don't want to pass non-dom props to the DOM, | ||
| // but we still wat to forward them to a uses component. | ||
| if (isTag && !isPropValid(prop)) continue | ||
| childProps[prop] = props[prop] | ||
| } | ||
| // $FlowFixMe flow seems to not know that `classes` will be provided by the HOC, not by element creator. | ||
| childProps.className = className ? `${className} ${classes.css}` : classes.css | ||
| return React.createElement(as || type, childProps) | ||
| } | ||
|
|
||
| // $FlowFixMe flow seems to not know that `classes` will be provided by the HOC, not by element creator. | ||
| return withStyles({css: style}, {...options, injectTheme: true})(Styled) | ||
|
There was a problem hiding this comment. This implementation is good for now, but I would like to optimize it, later on, to not render two extra react components for example. I'm not sure if we should use the hooks implementation in here yet, as this would make the There was a problem hiding this comment. I actually think performance is critical and this amount of components for each styled one is really bad, that's why I think hooks api is the only way forward with this API. For those who use older react versions they still can use the old styled implementation. |
||
| } | ||
| } | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,196 @@ | ||
| // @flow | ||
| /* eslint-disable react/prop-types */ | ||
| import expect from 'expect.js' | ||
| import React from 'react' | ||
| import TestRenderer from 'react-test-renderer' | ||
| import {stripIndent} from 'common-tags' | ||
| import {styled, SheetsRegistry, JssProvider, ThemeProvider} from '.' | ||
|
|
||
| const createGenerateId = () => { | ||
| let counter = 0 | ||
| return rule => `${rule.key}-${counter++}` | ||
| } | ||
|
|
||
| describe('React-JSS: styled', () => { | ||
| it('should render static styles', () => { | ||
| const registry = new SheetsRegistry() | ||
| const Div = styled('div')({color: 'red'}) | ||
| const renderer = TestRenderer.create( | ||
| <JssProvider registry={registry} generateId={createGenerateId()}> | ||
| <Div /> | ||
| </JssProvider> | ||
| ) | ||
| expect(registry.toString()).to.be(stripIndent` | ||
| .css-0 { | ||
| color: red; | ||
| } | ||
| `) | ||
| const {className, classes} = renderer.root.findByType('div').props | ||
| expect(className).to.be('css-0') | ||
| expect(classes).to.be(undefined) | ||
| }) | ||
|
|
||
| it('should render dynamic styles', () => { | ||
| const registry = new SheetsRegistry() | ||
| const Div = styled('div')({ | ||
| color: 'red', | ||
| width: () => 10 | ||
| }) | ||
| const renderer = TestRenderer.create( | ||
| <JssProvider registry={registry} generateId={createGenerateId()}> | ||
| <Div /> | ||
| </JssProvider> | ||
| ) | ||
| expect(registry.toString()).to.be(stripIndent` | ||
| .css-0 { | ||
| color: red; | ||
| } | ||
| .css-0-1 { | ||
| width: 10px; | ||
| } | ||
| `) | ||
| expect(renderer.root.findByType('div').props.className).to.be('css-0 css-0-1') | ||
| }) | ||
|
|
||
| it('should merge with user class name', () => { | ||
| const registry = new SheetsRegistry() | ||
| const Div = styled('div')({color: 'red'}) | ||
| const renderer = TestRenderer.create( | ||
| <JssProvider registry={registry} generateId={createGenerateId()}> | ||
| <Div className="my-class" /> | ||
| </JssProvider> | ||
| ) | ||
| expect(registry.toString()).to.be(stripIndent` | ||
| .css-0 { | ||
| color: red; | ||
| } | ||
| `) | ||
| expect(renderer.root.findByType('div').props.className).to.be('my-class css-0') | ||
| }) | ||
|
|
||
| it('should use "as" prop', () => { | ||
| const registry = new SheetsRegistry() | ||
| const Div = styled('div')({color: 'red'}) | ||
| const renderer = TestRenderer.create( | ||
| <JssProvider registry={registry} generateId={createGenerateId()}> | ||
| <Div as="button" /> | ||
| </JssProvider> | ||
| ) | ||
| expect(registry.toString()).to.be(stripIndent` | ||
| .css-0 { | ||
| color: red; | ||
| } | ||
| `) | ||
| expect(renderer.root.findByType('button').props.className).to.be('css-0') | ||
| }) | ||
|
|
||
| it('should not leak non-dom attrs', () => { | ||
| const registry = new SheetsRegistry() | ||
| const Div = styled('div')({ | ||
| color: 'red', | ||
| width: props => props.s | ||
| }) | ||
| const renderer = TestRenderer.create( | ||
| <JssProvider registry={registry} generateId={createGenerateId()}> | ||
| <Div s={10} /> | ||
| </JssProvider> | ||
| ) | ||
| expect(registry.toString()).to.be(stripIndent` | ||
| .css-0 { | ||
| color: red; | ||
| } | ||
| .css-0-1 { | ||
| width: 10px; | ||
| } | ||
| `) | ||
| const {className, s} = renderer.root.findByType('div').props | ||
| expect(className).to.be('css-0 css-0-1') | ||
| expect(s).to.be(undefined) | ||
| }) | ||
|
|
||
| it('should compose with styled component', () => { | ||
| const registry = new SheetsRegistry() | ||
| const BaseDiv = styled('div')({color: 'red'}) | ||
| const Div = styled(BaseDiv)({width: 10}) | ||
| const renderer = TestRenderer.create( | ||
| <JssProvider registry={registry} generateId={createGenerateId()}> | ||
| <Div /> | ||
| </JssProvider> | ||
| ) | ||
| expect(registry.toString()).to.be(stripIndent` | ||
| .css-1 { | ||
| color: red; | ||
| } | ||
| .css-0 { | ||
| width: 10px; | ||
| } | ||
| `) | ||
| const {className} = renderer.root.findByType('div').props | ||
| expect(className).to.be('css-0 css-1') | ||
| }) | ||
|
|
||
| it('should style any component', () => { | ||
| const registry = new SheetsRegistry() | ||
| const BaseDiv = ({className}) => <div className={className} /> | ||
| const Div = styled(BaseDiv)({width: 10}) | ||
| const renderer = TestRenderer.create( | ||
| <JssProvider registry={registry} generateId={createGenerateId()}> | ||
| <Div /> | ||
| </JssProvider> | ||
| ) | ||
| expect(registry.toString()).to.be(stripIndent` | ||
| .css-0 { | ||
| width: 10px; | ||
| } | ||
| `) | ||
| const {className} = renderer.root.findByType('div').props | ||
| expect(className).to.be('css-0') | ||
| }) | ||
|
|
||
| it.skip('should target another styled component (not sure if we really need this)', () => { | ||
| const registry = new SheetsRegistry() | ||
| const Span = styled('span')({color: 'red'}) | ||
| const Div = styled('div')({ | ||
| // $FlowFixMe | ||
| [Span]: { | ||
| color: 'green' | ||
| } | ||
| }) | ||
|
|
||
| const renderer = TestRenderer.create( | ||
| <JssProvider registry={registry} generateId={createGenerateId()}> | ||
| <Div /> | ||
| </JssProvider> | ||
| ) | ||
| expect(registry.toString()).to.be(stripIndent` | ||
| .css-0 { | ||
| width: 10px; | ||
| } | ||
| `) | ||
| expect(renderer.root.findByType('div').props.className).to.be('XXX') | ||
| expect(renderer.root.findByType('span').props.className).to.be('XXX') | ||
| }) | ||
|
|
||
| it('should render theme', () => { | ||
| const registry = new SheetsRegistry() | ||
| const Div = styled('div')({ | ||
| color: 'red', | ||
| margin: props => props.theme.spacing | ||
| }) | ||
| TestRenderer.create( | ||
| <JssProvider registry={registry} generateId={createGenerateId()}> | ||
| <ThemeProvider theme={{spacing: 10}}> | ||
| <Div /> | ||
| </ThemeProvider> | ||
| </JssProvider> | ||
| ) | ||
| expect(registry.toString()).to.be(stripIndent` | ||
| .css-0 { | ||
| color: red; | ||
| } | ||
| .css-0-1 { | ||
| margin: 10px; | ||
| } | ||
| `) | ||
| }) | ||
| }) |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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.
changes here are unrelated, but for some reason after I added tests for styled api, this tests started to fail, something weird started happening with module id, like there is a new moduleId module evaluation, I couldn't fully understand that, but I just started resetinng moduleId here.