Skip to content

feat: tooltips component with example #1006

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

Merged
merged 8 commits into from
Apr 15, 2024
Merged
Show file tree
Hide file tree
Changes from 6 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
3 changes: 3 additions & 0 deletions src/components/fields/Checkbox.tsx
Original file line number Diff line number Diff line change
@@ -1,9 +1,11 @@
import type { FC, ReactNode } from 'react';
import { Tooltip } from './Tooltip';

export interface ICheckbox {
name: string;
label: string;
helpText?: ReactNode | string;
tooltip?: ReactNode | string;
checked: boolean;
disabled?: boolean;
onChange: (evt: React.ChangeEvent<HTMLInputElement>) => void;
Expand Down Expand Up @@ -33,6 +35,7 @@ export const Checkbox: FC<ICheckbox> = (props: ICheckbox) => {
}
>
{props.label}
{props.tooltip && <Tooltip tooltip={props.tooltip} />}
</label>
</div>
</div>
Expand Down
28 changes: 28 additions & 0 deletions src/components/fields/Tooltip.test.tsx
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
import { fireEvent, render, screen } from '@testing-library/react';

import * as TestRenderer from 'react-test-renderer';

import { type ITooltip, Tooltip } from './Tooltip';

describe('components/fields/Tooltip.tsx', () => {
const props: ITooltip = {
tooltip: 'This is some tooltip text',
};

it('should render', () => {
const tree = TestRenderer.create(<Tooltip {...props} />);
expect(tree).toMatchSnapshot();
});

it('should display on mouse enter / leave', () => {
render(<Tooltip {...props} />);

const tooltipElement = screen.getByTitle('tooltip');

fireEvent.mouseEnter(tooltipElement);
expect(tooltipElement).toMatchSnapshot();

fireEvent.mouseLeave(tooltipElement);
expect(tooltipElement).toMatchSnapshot();
});
});
28 changes: 28 additions & 0 deletions src/components/fields/Tooltip.tsx
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
import { QuestionIcon } from '@primer/octicons-react';
import { type FC, type ReactNode, useState } from 'react';

export interface ITooltip {
tooltip: ReactNode | string;
}

export const Tooltip: FC<ITooltip> = (props: ITooltip) => {
const [showTooltip, setShowTooltip] = useState(false);

return (
<span
title="tooltip"
className="relative"
onMouseEnter={() => setShowTooltip(true)}
onMouseLeave={() => setShowTooltip(false)}
>
<QuestionIcon className="text-blue-500 ml-1" />
{showTooltip && (
<div className="absolute bg-white dark:bg-gray-sidebar border border-gray-300 rounded p-2 shadow">
<div className="text-gray-700 dark:text-white text-xs text-left">
{props.tooltip}
</div>
</div>
)}
</span>
);
};

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

85 changes: 85 additions & 0 deletions src/components/fields/__snapshots__/Tooltip.test.tsx.snap

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

13 changes: 13 additions & 0 deletions src/routes/Settings.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -141,6 +141,19 @@ export const SettingsRoute: FC = () => {
colorScope && updateSetting('colors', evt.target.checked)
}
disabled={!colorScope}
tooltip={
<div>
<div className="pb-3">
Enrich notifications with author or last commenter profile
information, state and GitHub-like colors.
</div>
<div className="text-orange-600">
⚠️ Users with a large number of unread notifications <i>may</i>{' '}
experience rate limiting under certain circumstances. Disable
this setting if you experience this.
</div>
</div>
}
/>
<Checkbox
name="showAccountHostname"
Expand Down
38 changes: 38 additions & 0 deletions src/routes/__snapshots__/Settings.test.tsx.snap

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.