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

Jump to bottom

feat: enabling tooltip on drawer triggers in AppLayout #2861

Closed
wants to merge 1 commit into from
+389 −175
Closed

feat: enabling tooltip on drawer triggers in AppLayout #2861

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
5 changes: 1 addition & 4 deletions src/app-layout/__integ__/toolbar-tooltips/app-layout-toolbar-drawer-trigger-tooltip.test.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,7 @@ import { setupTest } from '../utils';

const wrapper = createWrapper().findAppLayout();

describe('refresh-toolbar', () => {
//using a theme variable below that will be set when iterating over ['refresh-toolbar', 'refresh']
const theme = 'refresh-toolbar';

describe.each(['refresh', 'refresh-toolbar'] as const)('%s', theme => {
describe.each(['desktop', 'mobile'] as const)('%s', size => {
const firstDrawerId = 'security'; //matches drawerIds[0]
const secondDrawerId = 'pro-help'; //matches drawerIds[1]
Expand Down
14 changes: 7 additions & 7 deletions src/app-layout/__integ__/toolbar-tooltips/app-layout-toolbar-no-tooltips.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ import { setupTest } from '../utils';

const wrapper = createWrapper().findAppLayout();

describe.each(['refresh', 'classic'] as const)('%s', theme => {
describe('No tooltips in classic', () => {
describe.each(['desktop', 'mobile'] as const)('%s', size => {
//matches drawerItems[0].id from 'lib/dev-pages/pages/app-layout/utils/drawers';
const firstDrawerId = 'security';
Expand All @@ -14,7 +14,7 @@ describe.each(['refresh', 'classic'] as const)('%s', theme => {

test(
'No drawer trigger tooltip showing for mouse interactions',
setupTest({ size, theme }, async page => {
setupTest({ size, theme: 'classic' }, async page => {
await expect(page.isExisting(triggerTooltipSelector)).resolves.toBe(false);
await page.hoverElement(firstDrawerTriggerSelector);
await expect(page.isExisting(triggerTooltipSelector)).resolves.toBe(false);
Expand All @@ -23,7 +23,7 @@ describe.each(['refresh', 'classic'] as const)('%s', theme => {

test(
'No drawer trigger tooltip showing for pointer interactions',
setupTest({ size, theme }, async page => {
setupTest({ size, theme: 'classic' }, async page => {
await expect(page.isExisting(triggerTooltipSelector)).resolves.toBe(false);
await page.buttonDownOnElement(firstDrawerTriggerSelector);
await expect(page.isExisting(triggerTooltipSelector)).resolves.toBe(false);
Expand All @@ -32,7 +32,7 @@ describe.each(['refresh', 'classic'] as const)('%s', theme => {

test(
'No drawer trigger tooltip showing for keyboard (tab) interactions',
setupTest({ size, theme }, async page => {
setupTest({ size, theme: 'classic' }, async page => {
await expect(page.isExisting(triggerTooltipSelector)).resolves.toBe(false);
//set focus by clicking open and close
await page.click(firstDrawerTriggerSelector);
Expand All @@ -49,7 +49,7 @@ describe.each(['refresh', 'classic'] as const)('%s', theme => {
describe.each(['bottom', 'side'] as const)('splitPanelPosition=%s', splitPanelPosition => {
test(
'No split panel trigger tooltip showing for mouse interactions',
setupTest({ size, theme, splitPanelPosition }, async page => {
setupTest({ size, theme: 'classic', splitPanelPosition }, async page => {
await expect(page.isExisting(triggerTooltipSelector)).resolves.toBe(false);
await page.hoverElement(wrapper.findSplitPanelOpenButton().toSelector());
await expect(page.isExisting(triggerTooltipSelector)).resolves.toBe(false);
Expand All @@ -58,7 +58,7 @@ describe.each(['refresh', 'classic'] as const)('%s', theme => {

test(
'No split panel trigger tooltip showing for pointer interactions',
setupTest({ size, theme, splitPanelPosition }, async page => {
setupTest({ size, theme: 'classic', splitPanelPosition }, async page => {
await expect(page.isExisting(triggerTooltipSelector)).resolves.toBe(false);
await page.buttonDownOnElement(wrapper.findSplitPanelOpenButton().toSelector());
await expect(page.isExisting(triggerTooltipSelector)).resolves.toBe(false);
Expand All @@ -67,7 +67,7 @@ describe.each(['refresh', 'classic'] as const)('%s', theme => {

test(
'No split panel trigger tooltip showing for keyboard (tab) interactions',
setupTest({ size, theme, splitPanelPosition }, async page => {
setupTest({ size, theme: 'classic', splitPanelPosition }, async page => {
await expect(page.isExisting(triggerTooltipSelector)).resolves.toBe(false);
//set focus by clicking open and close
await page.click(wrapper.findSplitPanelOpenButton().toSelector());
Expand Down
4 changes: 1 addition & 3 deletions ...-layout/__integ__/toolbar-tooltips/app-layout-toolbar-split-panel-trigger-tooltip.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,7 @@ import { AppLayoutDrawersPage, setupTest } from '../utils';

const wrapper = createWrapper().findAppLayout();

describe('refresh-toolbar', () => {
const theme = 'refresh-toolbar';

describe.each(['refresh', 'refresh-toolbar'] as const)('%s', theme => {
describe.each(['desktop', 'mobile'] as const)('%s', size => {
//matches drawerItems[0].id from '../../../../lib/dev-pages/pages/app-layout/utils/drawers';
const firstDrawerId = 'security';
Expand Down
67 changes: 32 additions & 35 deletions src/app-layout/__tests__/drawers.test.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -197,7 +197,7 @@ describeEachAppLayout(({ size, theme }) => {
expect(drawerTrigger!.getElement()).not.toHaveClass(selectedClass);
});

testIf(theme === 'refresh-toolbar')('tooltip renders correctly on focus, blur, and escape key press events', () => {
testIf(theme !== 'classic')('tooltip renders correctly on focus, blur, and escape key press events', () => {
const mockDrawers = [testDrawer];
const result = render(<AppLayout drawers={mockDrawers} />);
const wrapper = createWrapper(result.container).findAppLayout();
Expand Down Expand Up @@ -228,41 +228,38 @@ describeEachAppLayout(({ size, theme }) => {
expect(() => result.getByTestId(testDrawer.ariaLabels.drawerName)).toThrow();
});

testIf(theme === 'refresh-toolbar')(
'tooltip renders correctly on pointer events and is removed on escape key press',
() => {
const mockDrawers = [testDrawer];
const result = render(<AppLayout drawers={mockDrawers} />);
const wrapper = createWrapper(result.container).findAppLayout();
expect(wrapper!.findDrawerTriggerTooltip()).toBeNull();
expect(() => result.getByTestId(testDrawer.ariaLabels.drawerName)).toThrow();

const items = wrapper!.findDrawersTriggers();
expect(items?.length).toEqual(mockDrawers.length);

fireEvent.pointerEnter(items![0].getElement());
expect(wrapper!.findDrawerTriggerTooltip()).toBeTruthy();
expect(result.getByText(testDrawer.ariaLabels.drawerName)).toBeTruthy();

fireEvent.pointerLeave(items![0].getElement());
expect(wrapper!.findDrawerTriggerTooltip()).toBeNull();
expect(() => result.getByTestId(testDrawer.ariaLabels.drawerName)).toThrow();

fireEvent.pointerEnter(items![0].getElement());
expect(wrapper!.findDrawerTriggerTooltip()).toBeTruthy();
expect(result.getByText(testDrawer.ariaLabels.drawerName)).toBeTruthy();

fireEvent.keyDown(items![0].getElement(), {
...mockEventBubble,
key: 'Escape',
code: KeyCode.escape,
});
expect(wrapper!.findDrawerTriggerTooltip()).toBeNull();
expect(() => result.getByTestId(testDrawer.ariaLabels.drawerName)).toThrow();
}
);
testIf(theme !== 'classic')('tooltip renders correctly on pointer events and is removed on escape key press', () => {
const mockDrawers = [testDrawer];
const result = render(<AppLayout drawers={mockDrawers} />);
const wrapper = createWrapper(result.container).findAppLayout();
expect(wrapper!.findDrawerTriggerTooltip()).toBeNull();
expect(() => result.getByTestId(testDrawer.ariaLabels.drawerName)).toThrow();

const items = wrapper!.findDrawersTriggers();
expect(items?.length).toEqual(mockDrawers.length);

fireEvent.pointerEnter(items![0].getElement());
expect(wrapper!.findDrawerTriggerTooltip()).toBeTruthy();
expect(result.getByText(testDrawer.ariaLabels.drawerName)).toBeTruthy();

fireEvent.pointerLeave(items![0].getElement());
expect(wrapper!.findDrawerTriggerTooltip()).toBeNull();
expect(() => result.getByTestId(testDrawer.ariaLabels.drawerName)).toThrow();

fireEvent.pointerEnter(items![0].getElement());
expect(wrapper!.findDrawerTriggerTooltip()).toBeTruthy();
expect(result.getByText(testDrawer.ariaLabels.drawerName)).toBeTruthy();

fireEvent.keyDown(items![0].getElement(), {
...mockEventBubble,
key: 'Escape',
code: KeyCode.escape,
});
expect(wrapper!.findDrawerTriggerTooltip()).toBeNull();
expect(() => result.getByTestId(testDrawer.ariaLabels.drawerName)).toThrow();
});

testIf(theme === 'refresh-toolbar')('tooltip does not render on trigger focus via close button', () => {
testIf(theme !== 'classic')('tooltip does not render on trigger focus via close button', () => {
const mockDrawers = [testDrawer];
const result = render(<AppLayout drawers={mockDrawers} />);
const wrapper = createWrapper(result.container).findAppLayout();
Expand Down
Loading
Loading