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

Fix #3241: Tooltip allow event=both for handling hover and focus. #3243

Merged
merged 1 commit into from
Sep 5, 2022
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
2 changes: 1 addition & 1 deletion api-generator/components/tooltip.js
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ const TooltipProps = [
name: 'event',
type: 'string',
default: 'hover',
description: 'Event to show the tooltip, valid values are hover and focus.'
description: 'Event to show the tooltip, valid values are hover, focus, and both.'
},
{
name: 'showEvent',
Expand Down
8 changes: 4 additions & 4 deletions components/doc/tooltip/index.js
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
import React, { memo } from 'react';
import { TabView, TabPanel } from '../../lib/tabview/TabView';
import { useLiveEditorTabs } from '../common/liveeditor';
import { TabPanel, TabView } from '../../lib/tabview/TabView';
import { CodeHighlight } from '../common/codehighlight';
import { DevelopmentSection } from '../common/developmentsection';
import { useLiveEditorTabs } from '../common/liveeditor';

const TooltipDoc = memo(() => {
const sources = {
Expand Down Expand Up @@ -581,7 +581,7 @@ import { Tooltip } from 'primereact/tooltip';
</CodeHighlight>

<h5>Events</h5>
<p>Tooltip gets displayed on hover event of its target by default, other option is the focus event to display and blur to hide.</p>
<p>Tooltip gets displayed on hover event of its target by default, other option is the focus event to display and blur to hide. You can set it to 'both' to allow for both hover and focus events.</p>
<CodeHighlight>
{`
<InputText type="text" placeholder="Right" tooltip="Enter your username" tooltipOptions={{event: 'focus'}}/>
Expand Down Expand Up @@ -679,7 +679,7 @@ import { Tooltip } from 'primereact/tooltip';
<td>event</td>
<td>string</td>
<td>hover</td>
<td>Event to show the tooltip, valid values are hover and focus.</td>
<td>Event to show the tooltip, valid values are hover, focus, and both.</td>
</tr>
<tr>
<td>showEvent</td>
Expand Down
30 changes: 17 additions & 13 deletions components/lib/tooltip/Tooltip.js
Original file line number Diff line number Diff line change
Expand Up @@ -64,21 +64,25 @@ export const Tooltip = React.memo(
};

const getEvents = (target) => {
let showEvent = getTargetOption(target, 'showevent') || props.showEvent;
let hideEvent = getTargetOption(target, 'hideevent') || props.hideEvent;
let showEvents = [getTargetOption(target, 'showevent') || props.showEvent];
let hideEvents = [getTargetOption(target, 'hideevent') || props.hideEvent];

if (isMouseTrack(target)) {
showEvent = 'mousemove';
hideEvent = 'mouseleave';
showEvents = ['mousemove'];
hideEvents = ['mouseleave'];
} else {
const event = getTargetOption(target, 'event') || props.event;
if (event === 'focus') {
showEvent = 'focus';
hideEvent = 'blur';
showEvents = ['focus'];
hideEvents = ['blur'];
}
if (event === 'both') {
showEvents = ['focus', 'mouseenter'];
hideEvents = ['blur', 'mouseleave'];
}
}

return { showEvent, hideEvent };
return { showEvents, hideEvents };
};

const getPosition = (target) => {
Expand Down Expand Up @@ -271,19 +275,19 @@ export const Tooltip = React.memo(

const bindTargetEvent = (target) => {
if (target) {
const { showEvent, hideEvent } = getEvents(target);
const { showEvents, hideEvents } = getEvents(target);
const currentTarget = getTarget(target);
currentTarget.addEventListener(showEvent, show);
currentTarget.addEventListener(hideEvent, hide);
showEvents.forEach((event) => currentTarget.addEventListener(event, show));
hideEvents.forEach((event) => currentTarget.addEventListener(event, hide));
}
};

const unbindTargetEvent = (target) => {
if (target) {
const { showEvent, hideEvent } = getEvents(target);
const { showEvents, hideEvents } = getEvents(target);
const currentTarget = getTarget(target);
currentTarget.removeEventListener(showEvent, show);
currentTarget.removeEventListener(hideEvent, hide);
showEvents.forEach((event) => currentTarget.removeEventListener(event, show));
hideEvents.forEach((event) => currentTarget.removeEventListener(event, hide));
}
};

Expand Down
2 changes: 1 addition & 1 deletion components/lib/tooltip/tooltipoptions.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ import * as React from 'react';

type TooltipPositionType = 'top' | 'bottom' | 'left' | 'right';

type TooltipEventType = 'hover' | 'focus';
type TooltipEventType = 'hover' | 'focus' | 'both';

type TooltipAppendToType = 'self' | HTMLElement | undefined | null;

Expand Down
14 changes: 7 additions & 7 deletions pages/tooltip/index.js
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
import getConfig from 'next/config';
import Head from 'next/head';
import React, { useState } from 'react';
import { InputText } from '../../components/lib/inputtext/InputText';
import { DocActions } from '../../components/doc/common/docactions';
import TooltipDoc from '../../components/doc/tooltip';
import { Badge } from '../../components/lib/badge/Badge';
import { Button } from '../../components/lib/button/Button';
import { Tooltip } from '../../components/lib/tooltip/Tooltip';
import { InputText } from '../../components/lib/inputtext/InputText';
import { Knob } from '../../components/lib/knob/Knob';
import { Slider } from '../../components/lib/slider/Slider';
import { Badge } from '../../components/lib/badge/Badge';
import TooltipDoc from '../../components/doc/tooltip';
import { DocActions } from '../../components/doc/common/docactions';
import Head from 'next/head';
import getConfig from 'next/config';
import { Tooltip } from '../../components/lib/tooltip/Tooltip';

const TooltipDemo = () => {
const [saveBtnTooltipText, setSaveBtnTooltipText] = useState('Click to proceed');
Expand Down