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.

Sign up for GitHub

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

PanelBody refactored into functional component #23065

Closed
wants to merge 3 commits into from
Closed

PanelBody refactored into functional component #23065

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
7aca5ff
Use React hooks for PanelBody component
jccit Jun 10, 2020
f85e077
Replaced some state tests with side-effect tests
jccit Jun 10, 2020
7bd42e8
Remove state check in "opened" prop tests
jccit Jun 11, 2020
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
123 changes: 58 additions & 65 deletions packages/components/src/panel/body.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ import classnames from 'classnames';
/**
* WordPress dependencies
*/
import { Component, forwardRef } from '@wordpress/element';
import { forwardRef, useState } from '@wordpress/element';
import { chevronUp, chevronDown } from '@wordpress/icons';

/**
Expand All @@ -15,76 +15,69 @@ import { chevronUp, chevronDown } from '@wordpress/icons';
import Button from '../button';
import Icon from '../icon';

export class PanelBody extends Component {
constructor( props ) {
super( ...arguments );
this.state = {
opened: props.initialOpen === undefined ? true : props.initialOpen,
};
this.toggle = this.toggle.bind( this );
}
export function PanelBody( {
title,
children,
opened,
className,
icon,
forwardedRef,
initialOpen,
onToggle,
} ) {
const [ isOpenedState, setOpenedState ] = useState(
initialOpen === undefined ? true : initialOpen
);
Comment on lines +25 to +30
Copy link
Member

Choose a reason for hiding this comment

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

This can be simplified using a default parameter.

Suggested change
initialOpen,
onToggle,
} ) {
const [ isOpenedState, setOpenedState ] = useState(
initialOpen === undefined ? true : initialOpen
);
initialOpen = true,
onToggle,
} ) {
const [ isOpenedState, setOpenedState ] = useState( initialOpen );

const isOpened = opened === undefined ? isOpenedState : opened;
Copy link
Member

Choose a reason for hiding this comment

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

This can be simplified using nullish coalescing:

Suggested change
const isOpened = opened === undefined ? isOpenedState : opened;
const isOpened = opened ?? isOpenedState;


toggle( event ) {
const classes = classnames( 'components-panel__body', className, {
'is-opened': isOpened,
} );

const toggle = ( event ) => {
event.preventDefault();
if ( this.props.opened === undefined ) {
this.setState( ( state ) => ( {
opened: ! state.opened,
} ) );
if ( opened === undefined ) {
setOpenedState( ! isOpenedState );
}

if ( this.props.onToggle ) {
this.props.onToggle();
if ( onToggle ) {
onToggle();
}
Comment on lines +43 to 45
Copy link
Member

Choose a reason for hiding this comment

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

This can be simplified using optional chaining:

Suggested change
if ( onToggle ) {
onToggle();
}
onToggle?.();

}

render() {
const {
title,
children,
opened,
className,
icon,
forwardedRef,
} = this.props;
const isOpened = opened === undefined ? this.state.opened : opened;
const classes = classnames( 'components-panel__body', className, {
'is-opened': isOpened,
} );
};

return (
<div className={ classes } ref={ forwardedRef }>
{ !! title && (
<h2 className="components-panel__body-title">
<Button
className="components-panel__body-toggle"
onClick={ this.toggle }
aria-expanded={ isOpened }
>
{ /*
Firefox + NVDA don't announce aria-expanded because the browser
repaints the whole element, so this wrapping span hides that.
*/ }
<span aria-hidden="true">
<Icon
className="components-panel__arrow"
icon={ isOpened ? chevronUp : chevronDown }
/>
</span>
{ title }
{ icon && (
<Icon
icon={ icon }
className="components-panel__icon"
size={ 20 }
/>
) }
</Button>
</h2>
) }
{ isOpened && children }
</div>
);
}
return (
<div className={ classes } ref={ forwardedRef }>
{ !! title && (
<h2 className="components-panel__body-title">
<Button
className="components-panel__body-toggle"
onClick={ toggle }
aria-expanded={ isOpened }
>
{ /*
Firefox + NVDA don't announce aria-expanded because the browser
repaints the whole element, so this wrapping span hides that.
*/ }
<span aria-hidden="true">
<Icon
className="components-panel__arrow"
icon={ isOpened ? chevronUp : chevronDown }
/>
</span>
{ title }
{ icon && (
<Icon
icon={ icon }
className="components-panel__icon"
size={ 20 }
/>
) }
</Button>
</h2>
) }
{ isOpened && children }
</div>
);
}

const forwardedPanelBody = ( props, ref ) => {
Expand Down
55 changes: 33 additions & 22 deletions packages/components/src/panel/test/body.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,18 @@ import { shallow, mount } from 'enzyme';
*/
import { PanelBody } from '../body';

function getToggleButton( container ) {
return container.find( '.components-panel__body-toggle' ).first();
}

function clickToggle( container ) {
getToggleButton( container ).simulate( 'click' );
}

function getOpened( container ) {
return getToggleButton( container ).prop( 'aria-expanded' );
}

describe( 'PanelBody', () => {
describe( 'basic rendering', () => {
it( 'should render an empty div with the matching className', () => {
Expand All @@ -22,10 +34,7 @@ describe( 'PanelBody', () => {
const panelBody = shallow( <PanelBody title="Some Text" /> );
const button = panelBody.find( '.components-panel__body-toggle' );
expect( panelBody.hasClass( 'is-opened' ) ).toBe( true );
expect( panelBody.state( 'opened' ) ).toBe( true );
expect( button.prop( 'onClick' ) ).toBe(
panelBody.instance().toggle
);
expect( getOpened( panelBody ) ).toBe( true );
expect( button.childAt( 0 ).name() ).toBe( 'span' );
expect( button.childAt( 0 ).childAt( 0 ).name() ).toBe( 'Icon' );
expect( button.childAt( 1 ).text() ).toBe( 'Some Text' );
Expand All @@ -35,7 +44,6 @@ describe( 'PanelBody', () => {
const panelBody = shallow(
<PanelBody title="Some Text" initialOpen={ false } />
);
expect( panelBody.state( 'opened' ) ).toBe( false );
expect( panelBody.hasClass( 'is-opened' ) ).toBe( false );
} );

Expand All @@ -47,51 +55,54 @@ describe( 'PanelBody', () => {
initialOpen={ false }
/>
);
expect( panelBody.state( 'opened' ) ).toBe( false );
expect( panelBody.hasClass( 'is-opened' ) ).toBe( true );
} );

it( 'should render child elements within PanelBody element', () => {
const panelBody = shallow( <PanelBody children="Some Text" /> );
expect( panelBody.instance().props.children ).toBe( 'Some Text' );
const panelBody = mount( <PanelBody children="Some Text" /> );
expect( panelBody.prop( 'children' ) ).toBe( 'Some Text' );
expect( panelBody.text() ).toBe( 'Some Text' );
} );

it( 'should pass children prop but not render when sidebar is closed', () => {
const panelBody = shallow(
const panelBody = mount(
<PanelBody children="Some Text" initialOpen={ false } />
);
expect( panelBody.instance().props.children ).toBe( 'Some Text' );
expect( panelBody.prop( 'children' ) ).toBe( 'Some Text' );
// Text should be empty even though props.children is set.
expect( panelBody.text() ).toBe( '' );
} );
} );

describe( 'mounting behavior', () => {
it( 'should mount with a default of being opened', () => {
const panelBody = mount( <PanelBody /> );
expect( panelBody.state( 'opened' ) ).toBe( true );
const panelBody = mount( <PanelBody title="Some Text" /> );
expect( getOpened( panelBody ) ).toBe( true );
} );

it( 'should mount with a state of not opened when initialOpen set to false', () => {
const panelBody = mount( <PanelBody initialOpen={ false } /> );
expect( panelBody.state( 'opened' ) ).toBe( false );
const panelBody = mount(
<PanelBody title="Some Text" initialOpen={ false } />
);
expect( getOpened( panelBody ) ).toBe( false );
} );
} );

describe( 'toggling behavior', () => {
const fakeEvent = { preventDefault: () => undefined };

it( 'should set the opened state to false when a toggle fires', () => {
const panelBody = mount( <PanelBody /> );
panelBody.instance().toggle( fakeEvent );
expect( panelBody.state( 'opened' ) ).toBe( false );
const panelBody = mount( <PanelBody title="Some Text" /> );

clickToggle( panelBody );
expect( getOpened( panelBody ) ).toBe( false );
} );

it( 'should set the opened state to true when a toggle fires on a closed state', () => {
const panelBody = mount( <PanelBody initialOpen={ false } /> );
panelBody.instance().toggle( fakeEvent );
expect( panelBody.state( 'opened' ) ).toBe( true );
const panelBody = mount(
<PanelBody title="Some Text" initialOpen={ false } />
);

clickToggle( panelBody );
expect( getOpened( panelBody ) ).toBe( true );
} );
} );
} );