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

Remove findDOMNode from Tooltip component #11169

Merged
merged 2 commits into from
Oct 31, 2018
Merged

Remove findDOMNode from Tooltip component #11169

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0cbf958
Remove findDOMNode from Tooltip component
youknowriad Oct 28, 2018
51c8be7
update components changelog
youknowriad Oct 31, 2018
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
6 changes: 6 additions & 0 deletions packages/components/CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
## 5.0.2 (Unreleased)

### Polish

- Tooltip are no longer removed when Button becomes disabled, it's left to the component rendering the Tooltip.

## 5.0.1 (2018-10-30)

## 5.0.0 (2018-10-29)
Expand Down
7 changes: 5 additions & 2 deletions packages/components/src/icon-button/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ class IconButton extends Component {
const tooltipText = tooltip || label;

// Should show the tooltip if...
const showTooltip = (
const showTooltip = ! additionalProps.disabled && (
// an explicit tooltip is passed or...
tooltip ||
// there's a shortcut or...
Expand All @@ -49,7 +49,10 @@ class IconButton extends Component {

if ( showTooltip ) {
element = (
<Tooltip text={ tooltipText } shortcut={ shortcut }>
<Tooltip
text={ tooltipText }
shortcut={ shortcut }
>
{ element }
</Tooltip>
);
Expand Down
62 changes: 0 additions & 62 deletions packages/components/src/tooltip/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,6 @@ import {
Component,
Children,
cloneElement,
findDOMNode,
concatChildren,
} from '@wordpress/element';

Expand All @@ -31,7 +30,6 @@ class Tooltip extends Component {
constructor() {
super( ...arguments );

this.bindNode = this.bindNode.bind( this );
this.delayedSetIsOver = debounce(
( isOver ) => this.setState( { isOver } ),
TOOLTIP_DELAY
Expand All @@ -44,65 +42,6 @@ class Tooltip extends Component {

componentWillUnmount() {
this.delayedSetIsOver.cancel();
this.disconnectDisabledAttributeObserver();
}

componentDidUpdate( prevProps, prevState ) {
const { isOver } = this.state;
if ( isOver !== prevState.isOver ) {
if ( isOver ) {
this.observeDisabledAttribute();
} else {
this.disconnectDisabledAttributeObserver();
}
}
}

/**
* Assigns DOM node of the rendered component as an instance property.
*
* @param {Element} ref Rendered component reference.
*/
bindNode( ref ) {
// Disable reason: Because render clones the child, we don't know what
// type of element we have, but if it's a DOM node, we want to observe
// the disabled attribute.
// eslint-disable-next-line react/no-find-dom-node
this.node = findDOMNode( ref );
}

/**
* Disconnects any DOM observer attached to the rendered node.
*/
disconnectDisabledAttributeObserver() {
if ( this.observer ) {
this.observer.disconnect();
}
}

/**
* Adds a DOM observer to the rendered node, if supported and if the DOM
* node exists, to monitor for application of a disabled attribute.
*/
observeDisabledAttribute() {
if ( ! window.MutationObserver || ! this.node ) {
return;
}

this.observer = new window.MutationObserver( ( [ mutation ] ) => {
if ( mutation.target.disabled ) {
// We can assume here that isOver is true, because mutation
// observer is only attached for duration of isOver active
this.setState( { isOver: false } );
}
} );

// Monitor changes to the disable attribute on the DOM node
this.observer.observe( this.node, {
subtree: true,
attributes: true,
attributeFilter: [ 'disabled' ],
} );
}

emitToChild( eventName, event ) {
Expand Down Expand Up @@ -163,7 +102,6 @@ class Tooltip extends Component {
const child = Children.only( children );
const { isOver } = this.state;
return cloneElement( child, {
ref: this.bindNode,
onMouseEnter: this.createToggleIsOver( 'onMouseEnter', true ),
onMouseLeave: this.createToggleIsOver( 'onMouseLeave' ),
onClick: this.createToggleIsOver( 'onClick' ),
Expand Down