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

[HOC] Add innerRef to withWidth and withTheme #12236

Merged
merged 1 commit into from
Jul 22, 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: 1 addition & 0 deletions packages/material-ui/src/styles/withTheme.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ import { ConsistentWith } from '..';

export interface WithTheme {
theme: Theme;
innerRef?: React.Ref<any> | React.RefObject<any>;
}

declare const withTheme: () => <P extends ConsistentWith<P, WithTheme>>(
Expand Down
11 changes: 10 additions & 1 deletion packages/material-ui/src/styles/withTheme.js
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
import React from 'react';
import PropTypes from 'prop-types';
import hoistNonReactStatics from 'hoist-non-react-statics';
import wrapDisplayName from 'recompose/wrapDisplayName';
import createMuiTheme from './createMuiTheme';
Expand Down Expand Up @@ -44,10 +45,18 @@ const withTheme = () => Component => {
}

render() {
return <Component theme={this.state.theme} {...this.props} />;
const { innerRef, ...other } = this.props;
return <Component theme={this.state.theme} ref={innerRef} {...other} />;
}
}

WithTheme.propTypes = {
/**
* Use that property to pass a ref callback to the decorated component.
*/
innerRef: PropTypes.oneOfType([PropTypes.func, PropTypes.object]),
};

WithTheme.contextTypes = themeListener.contextTypes;

if (process.env.NODE_ENV !== 'production') {
Expand Down
16 changes: 16 additions & 0 deletions packages/material-ui/src/styles/withTheme.test.js
Original file line number Diff line number Diff line change
@@ -1,11 +1,18 @@
import React from 'react';
import { assert } from 'chai';
import { spy } from 'sinon';
import createBroadcast from 'brcast';
import { createShallow, createMount } from '../test-utils';
import { CHANNEL } from './themeListener';
import withTheme from './withTheme';

const Empty = () => <div />;
// eslint-disable-next-line react/prefer-stateless-function
class EmptyClass extends React.Component<{}> {
render() {
return <div />;
}
}

describe('withTheme', () => {
let shallow;
Expand Down Expand Up @@ -44,4 +51,13 @@ describe('withTheme', () => {
broadcast.setState(newTheme);
assert.strictEqual(wrapper.instance().state.theme, newTheme);
});

describe('prop: innerRef', () => {
it('should provide a ref on the inner component', () => {
const ThemedComponent = withTheme()(EmptyClass);
const handleRef = spy();
mount(<ThemedComponent innerRef={handleRef} />);
assert.strictEqual(handleRef.callCount, 1);
});
});
});
1 change: 1 addition & 0 deletions packages/material-ui/src/withWidth/withWidth.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ export interface WithWidthOptions {

export interface WithWidthProps {
width: Breakpoint;
innerRef?: React.Ref<any> | React.RefObject<any>;
}

export function isWidthDown(
Expand Down
8 changes: 6 additions & 2 deletions packages/material-ui/src/withWidth/withWidth.js
Original file line number Diff line number Diff line change
Expand Up @@ -98,7 +98,7 @@ const withWidth = (options = {}) => Component => {
}

render() {
const { initialWidth, theme, width, ...other } = this.props;
const { initialWidth, theme, width, innerRef, ...other } = this.props;

const props = {
width:
Expand Down Expand Up @@ -127,7 +127,7 @@ const withWidth = (options = {}) => Component => {

return (
<EventListener target="window" onResize={this.handleResize}>
<Component {...more} {...props} />
<Component {...more} {...props} ref={innerRef} />
</EventListener>
);
}
Expand All @@ -144,6 +144,10 @@ const withWidth = (options = {}) => Component => {
* http://caniuse.com/#search=client%20hint
*/
initialWidth: PropTypes.oneOf(['xs', 'sm', 'md', 'lg', 'xl']),
/**
* Use that property to pass a ref callback to the decorated component.
*/
innerRef: PropTypes.oneOfType([PropTypes.func, PropTypes.object]),
/**
* @ignore
*/
Expand Down
18 changes: 17 additions & 1 deletion packages/material-ui/src/withWidth/withWidth.test.js
Original file line number Diff line number Diff line change
@@ -1,12 +1,19 @@
import React from 'react';
import { assert } from 'chai';
import { useFakeTimers } from 'sinon';
import { useFakeTimers, spy } from 'sinon';
import { createMount, createShallow } from '../test-utils';
import withWidth, { isWidthDown, isWidthUp } from './withWidth';
import createBreakpoints from '../styles/createBreakpoints';
import createMuiTheme from '../styles/createMuiTheme';

const Empty = () => <div />;
// eslint-disable-next-line react/prefer-stateless-function
class EmptyClass extends React.Component<{}> {
render() {
return <div />;
}
}
const EmptyClassWithWidth = withWidth()(EmptyClass);
const EmptyWithWidth = withWidth()(Empty);

const breakpoints = createBreakpoints({});
Expand Down Expand Up @@ -39,6 +46,15 @@ describe('withWidth', () => {
});
});

describe('prop: innerRef', () => {
it('should provide a ref on the inner component', () => {
const handleRef = spy();

mount(<EmptyClassWithWidth innerRef={handleRef} />);
assert.strictEqual(handleRef.callCount, 1);
});
});

describe('browser', () => {
it('should provide the right width to the child element', () => {
const wrapper = mount(<EmptyWithWidth />);
Expand Down