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

PureComponents, by default #34

Merged
merged 1 commit into from
Dec 3, 2018
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
1 change: 0 additions & 1 deletion .vscode/extensions.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
{
"recommendations": [
"dbaeumer.vscode-eslint",
"flowtype.flow-for-vscode",
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Going to (eventually) replace Flow with TS.
This will probably happen during the Emotion 9 -> 10 migration

"esbenp.prettier-vscode",
"jpoissonnier.vscode-styled-components"
]
Expand Down
17 changes: 15 additions & 2 deletions src/create-emotion-styled/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,18 @@ const contextTypes = {
[scopeChannel]: PropTypes.object,
}

function createEmotionStyled(emotion: Object, view: ReactType) {
const defaultProps = {
pure: true,
}

function createEmotionStyled(
emotion: Object,
view: ReactType,
options: Object,
) {
// Custom Fancy, non-Emotion default options
const {pure} = {...defaultProps, ...options}

let createStyled: CreateStyled = (tag, options) => {
if (process.env.NODE_ENV !== 'production') {
if (tag === undefined) {
Expand Down Expand Up @@ -85,7 +96,9 @@ function createEmotionStyled(emotion: Object, view: ReactType) {
}
}

class Styled extends view.Component<*, {theme: Object}> {
const OuterBaseComponent = pure ? view.PureComponent : view.Component
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pattern established in wedux (inspired by react-redux)


class Styled extends OuterBaseComponent<*, {theme: Object}> {
unsubscribe: number
unsubscribeFrame: number
mergedProps: Object
Expand Down
27 changes: 27 additions & 0 deletions src/create-styled/__tests__/create-styled.test.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
import React from 'react'
import {mount} from 'enzyme'
import createStyled from '../index'

test('Creates a React.PureComponent instance, by default', () => {
const Comp = createStyled()('div')``
const wrapper = mount(<Comp />)
const el = wrapper.getNodes()[0]

expect(el instanceof React.PureComponent).toBe(true)
})

test('Can create a React.Component instance, if defined', () => {
const Comp = createStyled({pure: false})('div')``
const wrapper = mount(<Comp />)
const el = wrapper.getNodes()[0]

expect(el instanceof React.Component).toBe(true)
})

test('Can create a React.PureComponent instance, if defined', () => {
const Comp = createStyled({pure: true})('div')``
const wrapper = mount(<Comp />)
const el = wrapper.getNodes()[0]

expect(el instanceof React.PureComponent).toBe(true)
})
13 changes: 13 additions & 0 deletions src/create-styled/index.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
// @flow
import React from 'react'
import * as emotion from '../emotion/index'
import createEmotionStyled from '../create-emotion-styled'

/**
* A custom HOC that wraps the default createEmotionStyled to allow
* for options, being passed through a custom argument.
*/

export default function createStyled(options) {
return createEmotionStyled(emotion, React, options)
}
6 changes: 2 additions & 4 deletions src/styled/index.js
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
// @flow
import React from 'react'
import * as emotion from '../emotion/index'
import createEmotionStyled from '../create-emotion-styled'
import createStyled from '../create-styled'

export default createEmotionStyled(emotion, React)
export default createStyled({pure: true})

export * from '../emotion/index'