Skip to content

Commit

Permalink
[Tooltip] Add enterNextDelay prop (#19766)
Browse files Browse the repository at this point in the history
  • Loading branch information
Ritorna committed Feb 21, 2020
1 parent e12d0dc commit 670b858
Show file tree
Hide file tree
Showing 4 changed files with 24 additions and 12 deletions.
3 changes: 2 additions & 1 deletion docs/pages/api/tooltip.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,8 @@ You can learn more about the difference by [reading this guide](/guides/minimizi
| <span class="prop-name">disableFocusListener</span> | <span class="prop-type">bool</span> | <span class="prop-default">false</span> | Do not respond to focus events. |
| <span class="prop-name">disableHoverListener</span> | <span class="prop-type">bool</span> | <span class="prop-default">false</span> | Do not respond to hover events. |
| <span class="prop-name">disableTouchListener</span> | <span class="prop-type">bool</span> | <span class="prop-default">false</span> | Do not respond to long press touch events. |
| <span class="prop-name">enterDelay</span> | <span class="prop-type">number</span> | <span class="prop-default">0</span> | The number of milliseconds to wait before showing the tooltip. This prop won't impact the enter touch delay (`enterTouchDelay`). |
| <span class="prop-name">enterDelay</span> | <span class="prop-type">number</span> | <span class="prop-default">200</span> | The number of milliseconds to wait before showing the tooltip. This prop won't impact the enter touch delay (`enterTouchDelay`). |
| <span class="prop-name">enterNextDelay</span> | <span class="prop-type">number</span> | <span class="prop-default">0</span> | The number of milliseconds to wait before showing the tooltip when one was already recently opened. |
| <span class="prop-name">enterTouchDelay</span> | <span class="prop-type">number</span> | <span class="prop-default">700</span> | The number of milliseconds a user must touch the element before showing the tooltip. |
| <span class="prop-name">id</span> | <span class="prop-type">string</span> | | This prop is used to help implement the accessibility logic. If you don't provide this prop. It falls back to a randomly generated id. |
| <span class="prop-name">interactive</span> | <span class="prop-type">bool</span> | <span class="prop-default">false</span> | Makes a tooltip interactive, i.e. will not close when the user hovers over the tooltip before the `leaveDelay` is expired. |
Expand Down
1 change: 1 addition & 0 deletions packages/material-ui/src/Tooltip/Tooltip.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ export interface TooltipProps
disableHoverListener?: boolean;
disableTouchListener?: boolean;
enterDelay?: number;
enterNextDelay?: number;
enterTouchDelay?: number;
id?: string;
interactive?: boolean;
Expand Down
22 changes: 14 additions & 8 deletions packages/material-ui/src/Tooltip/Tooltip.js
Original file line number Diff line number Diff line change
Expand Up @@ -183,7 +183,8 @@ const Tooltip = React.forwardRef(function Tooltip(props, ref) {
disableFocusListener = false,
disableHoverListener = false,
disableTouchListener = false,
enterDelay = 0,
enterDelay = 200,
enterNextDelay = 0,
enterTouchDelay = 700,
id: idProp,
interactive = false,
Expand Down Expand Up @@ -303,11 +304,14 @@ const Tooltip = React.forwardRef(function Tooltip(props, ref) {

clearTimeout(enterTimer.current);
clearTimeout(leaveTimer.current);
if (enterDelay && !hystersisOpen) {
if (enterDelay || (hystersisOpen && enterNextDelay)) {
event.persist();
enterTimer.current = setTimeout(() => {
handleOpen(event);
}, enterDelay);
enterTimer.current = setTimeout(
() => {
handleOpen(event);
},
hystersisOpen ? enterNextDelay : enterDelay,
);
} else {
handleOpen(event);
}
Expand Down Expand Up @@ -345,9 +349,7 @@ const Tooltip = React.forwardRef(function Tooltip(props, ref) {
clearTimeout(hystersisTimer);
hystersisTimer = setTimeout(() => {
hystersisOpen = false;
}, 500);
// Use 500 ms per https://github.com/reach/reach-ui/blob/3b5319027d763a3082880be887d7a29aee7d3afc/packages/tooltip/src/index.js#L214

}, 800 + leaveDelay);
setOpenState(false);

if (onClose) {
Expand Down Expand Up @@ -569,6 +571,10 @@ Tooltip.propTypes = {
* This prop won't impact the enter touch delay (`enterTouchDelay`).
*/
enterDelay: PropTypes.number,
/**
* The number of milliseconds to wait before showing the tooltip when one was already recently opened.
*/
enterNextDelay: PropTypes.number,
/**
* The number of milliseconds a user must touch the element before showing the tooltip.
*/
Expand Down
10 changes: 7 additions & 3 deletions packages/material-ui/src/Tooltip/Tooltip.test.js
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,7 @@ describe('<Tooltip />', () => {
const render = createClientRender({ strict: false });
let clock;
const defaultProps = {
enterDelay: 0,
children: (
<button id="testChild" type="submit">
Hello World
Expand Down Expand Up @@ -186,7 +187,7 @@ describe('<Tooltip />', () => {
const AutoFocus = props => (
<div>
{props.open ? (
<Tooltip title="Title">
<Tooltip {...defaultProps} title="Title">
<Input value="value" autoFocus />
</Tooltip>
) : null}
Expand Down Expand Up @@ -222,6 +223,7 @@ describe('<Tooltip />', () => {
<Tooltip
{...defaultProps}
enterDelay={111}
enterNextDelay={30}
leaveDelay={5}
TransitionProps={{ timeout: 6 }}
/>,
Expand All @@ -237,7 +239,9 @@ describe('<Tooltip />', () => {
expect(document.body.querySelectorAll('[role="tooltip"]').length).to.equal(0);

focusVisible(children);
// Bypass `enterDelay` wait, instant display.
// Bypass `enterDelay` wait, use `enterNextDelay`.
expect(document.body.querySelectorAll('[role="tooltip"]').length).to.equal(0);
clock.tick(30);
expect(document.body.querySelectorAll('[role="tooltip"]').length).to.equal(1);
});

Expand Down Expand Up @@ -351,7 +355,7 @@ describe('<Tooltip />', () => {
describe('prop: interactive', () => {
it('should keep the overlay open if the popper element is hovered', () => {
const wrapper = mount(
<Tooltip title="Hello World" interactive leaveDelay={111}>
<Tooltip {...defaultProps} title="Hello World" interactive leaveDelay={111}>
<button id="testChild" type="submit">
Hello World
</button>
Expand Down

0 comments on commit 670b858

Please sign in to comment.