-
Notifications
You must be signed in to change notification settings - Fork 4.3k
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
Components: Add withState higher-order component #4016
Merged
Merged
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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
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,32 @@ | ||
withState | ||
========= | ||
|
||
`withState` is a React [higher-order component](https://facebook.github.io/react/docs/higher-order-components.html) which enables a function component to have internal state. | ||
|
||
Wrapping a component with `withState` provides state as props to the wrapped component, along with a `setState` updater function. | ||
|
||
## Usage | ||
|
||
```jsx | ||
/** | ||
* WordPress dependencies | ||
*/ | ||
import { withState } from '@wordpress/components'; | ||
|
||
function MyCounter( { count, setState } ) { | ||
return ( | ||
<> | ||
Count: { count } | ||
<button onClick={ () => setState( ( state ) => ( { count: state.count + 1 } ) ) }> | ||
Increment | ||
</button> | ||
</> | ||
); | ||
} | ||
|
||
export default withState( { | ||
count: 0, | ||
} )( MyCounter ); | ||
``` | ||
|
||
`withState` optionally accepts an object argument to define the initial state. It returns a function which can then be used in composing your component. |
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,41 @@ | ||
/** | ||
* WordPress dependencies | ||
*/ | ||
import { Component, getWrapperDisplayName } from '@wordpress/element'; | ||
|
||
/** | ||
* A Higher Order Component used to provide and manage internal component state | ||
* via props. | ||
* | ||
* @param {?Object} initialState Optional initial state of the component | ||
* @return {Component} Wrapped component | ||
*/ | ||
function withState( initialState = {} ) { | ||
return ( OriginalComponent ) => { | ||
class WrappedComponent extends Component { | ||
constructor() { | ||
super( ...arguments ); | ||
|
||
this.setState = this.setState.bind( this ); | ||
|
||
this.state = initialState; | ||
} | ||
|
||
render() { | ||
return ( | ||
<OriginalComponent | ||
{ ...this.props } | ||
{ ...this.state } | ||
setState={ this.setState } | ||
/> | ||
); | ||
} | ||
} | ||
|
||
WrappedComponent.displayName = getWrapperDisplayName( WrappedComponent, 'state' ); | ||
|
||
return WrappedComponent; | ||
}; | ||
} | ||
|
||
export default withState; |
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,25 @@ | ||
/** | ||
* External dependencies | ||
*/ | ||
import { mount } from 'enzyme'; | ||
|
||
/** | ||
* Internal dependencies | ||
*/ | ||
import withState from '../'; | ||
|
||
describe( 'withState', () => { | ||
it( 'should pass initial state and allow updates', () => { | ||
const EnhancedComponent = withState( { count: 0 } )( ( { count, setState } ) => ( | ||
<button onClick={ () => setState( ( state ) => ( { count: state.count + 1 } ) ) }> | ||
{ count } | ||
</button> | ||
) ); | ||
|
||
const wrapper = mount( <EnhancedComponent /> ); | ||
|
||
expect( wrapper.html() ).toBe( '<button>0</button>' ); | ||
wrapper.find( 'button' ).simulate( 'click' ); | ||
expect( wrapper.html() ).toBe( '<button>1</button>' ); | ||
} ); | ||
} ); |
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
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.
Should we start using
React.Fragment
to avoid using keys? Do we want to update Babel first? :)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.
Yeah, I'd probably want to avoid the direct reference to
React.Fragment
, but if we had<>
syntax available, I'd be open to using it. Maybe in a subsequent pull request where we upgrade Babel?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.
Sure, I can spin up PR with Babel upgrade on Monday :)