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

fix: Fix visual bugs in drawer toggle buttons #1343

Merged
merged 1 commit into from
Jul 20, 2023
+127 −137
Merged

fix: Fix visual bugs in drawer toggle buttons #1343

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
8 changes: 0 additions & 8 deletions src/__integ__/__snapshots__/themes.test.ts.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -321,7 +321,6 @@ Object {
"color-foreground-control-default": "#ffffff",
"color-foreground-control-disabled": "#ffffff",
"color-shadow-default": "rgba(0, 28, 36, 0.5)",
"color-shadow-layout-toggle": "#d5dbdb",
"color-stroke-chart-line": "#879596",
"color-text-accent": "#0073bb",
"color-text-body-default": "#16191f",
Expand Down Expand Up @@ -931,7 +930,6 @@ Object {
"color-foreground-control-default": "#ffffff",
"color-foreground-control-disabled": "#687078",
"color-shadow-default": "rgba(0, 0, 0, 0.5)",
"color-shadow-layout-toggle": "#414750",
"color-stroke-chart-line": "#879596",
"color-text-accent": "#44b9d6",
"color-text-body-default": "#d5dbdb",
Expand Down Expand Up @@ -1541,7 +1539,6 @@ Object {
"color-foreground-control-default": "#ffffff",
"color-foreground-control-disabled": "#ffffff",
"color-shadow-default": "rgba(0, 28, 36, 0.5)",
"color-shadow-layout-toggle": "#d5dbdb",
"color-stroke-chart-line": "#879596",
"color-text-accent": "#0073bb",
"color-text-body-default": "#16191f",
Expand Down Expand Up @@ -2151,7 +2148,6 @@ Object {
"color-foreground-control-default": "#ffffff",
"color-foreground-control-disabled": "#ffffff",
"color-shadow-default": "rgba(0, 28, 36, 0.5)",
"color-shadow-layout-toggle": "#d5dbdb",
"color-stroke-chart-line": "#879596",
"color-text-accent": "#0073bb",
"color-text-body-default": "#16191f",
Expand Down Expand Up @@ -2761,7 +2757,6 @@ Object {
"color-foreground-control-default": "#ffffff",
"color-foreground-control-disabled": "#ffffff",
"color-shadow-default": "rgba(0, 7, 22, 0.12)",
"color-shadow-layout-toggle": "#d1d5db",
"color-stroke-chart-line": "#7d8998",
"color-text-accent": "#0972d3",
"color-text-body-default": "#000716",
Expand Down Expand Up @@ -3371,7 +3366,6 @@ Object {
"color-foreground-control-default": "#ffffff",
"color-foreground-control-disabled": "#ffffff",
"color-shadow-default": "rgba(0, 7, 22, 0.12)",
"color-shadow-layout-toggle": "#d1d5db",
"color-stroke-chart-line": "#7d8998",
"color-text-accent": "#0972d3",
"color-text-body-default": "#000716",
Expand Down Expand Up @@ -3981,7 +3975,6 @@ Object {
"color-foreground-control-default": "#000716",
"color-foreground-control-disabled": "#0f1b2a",
"color-shadow-default": "rgba(0, 7, 22, 1)",
"color-shadow-layout-toggle": "#354150",
"color-stroke-chart-line": "#7d8998",
"color-text-accent": "#539fe5",
"color-text-body-default": "#d1d5db",
Expand Down Expand Up @@ -4591,7 +4584,6 @@ Object {
"color-foreground-control-default": "#000716",
"color-foreground-control-disabled": "#0f1b2a",
"color-shadow-default": "rgba(0, 7, 22, 1)",
"color-shadow-layout-toggle": "#354150",
"color-stroke-chart-line": "#7d8998",
"color-text-accent": "#539fe5",
"color-text-body-default": "#d1d5db",
Expand Down
7 changes: 4 additions & 3 deletions src/app-layout/__integ__/app-layout-focus-delegation.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -91,13 +91,14 @@ function setupTest(
'drawers focus toggles between open and close buttons',
setupTest(
async page => {
await page.click(wrapper.findDrawersTriggers().get(2).toSelector());
const triggerSelector = wrapper.findDrawerTriggerById('pro-help').toSelector();
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

:nth-child does not work anymore, because every button has a wrapper now.

Since this feature is not in production yet, we can do such breaking changes

await page.click(triggerSelector);
await page.keys('Enter');
await expect(page.isFocused(wrapper.findDrawersTriggers().get(2).toSelector())).resolves.toBe(true);
await expect(page.isFocused(triggerSelector)).resolves.toBe(true);
await page.keys('Enter');
await expect(page.isFocused(wrapper.findActiveDrawerCloseButton().toSelector())).resolves.toBe(true);
await page.keys('Enter');
await expect(page.isFocused(wrapper.findDrawersTriggers().get(2).toSelector())).resolves.toBe(true);
await expect(page.isFocused(triggerSelector)).resolves.toBe(true);
},
{ pageName: 'with-drawers', visualRefresh, mobile }
)
Expand Down
5 changes: 4 additions & 1 deletion src/app-layout/__tests__/desktop.test.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -171,7 +171,10 @@ describeEachThemeAppLayout(false, () => {

test('Adds labels to toggle button and landmark when defined', () => {
const { wrapper } = renderComponent(<AppLayout contentType="form" {...singleDrawer} />);
expect(wrapper.findDrawersTriggers()![0].getElement()).toHaveAttribute('aria-label', 'Security trigger button');
expect(wrapper.findDrawerTriggerById('security')!.getElement()).toHaveAttribute(
'aria-label',
'Security trigger button'
);
expect(wrapper.findDrawersDesktopTriggersContainer()!.getElement()).toHaveAttribute('aria-label', 'Drawers');
});

Expand Down
11 changes: 3 additions & 8 deletions src/app-layout/constants.scss
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,14 +8,9 @@

// Toggle should have 40px width, whereas button is 26px wide.
// 40 - 26 = 14px in total or 7px on each side
$toggle-padding-horizontal: 0.7 * styles.$base-size;
$toggle-padding-vertical: awsui.$space-xxs;
$toggle-padding: $toggle-padding-vertical $toggle-padding-horizontal;

// New styles for when there are drawers
$drawers-padding-horizontal: 0.6 * styles.$base-size;
$drawers-padding-vertical: awsui.$space-scaled-xs;
$drawers-padding: $drawers-padding-vertical $drawers-padding-horizontal;
$_toggle-padding-horizontal: 0.7 * styles.$base-size;
$_toggle-padding-vertical: awsui.$space-xxs;
Comment on lines +11 to +12
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Prefix a variable with underscore makes it available only inside the current file

$toggle-padding: $_toggle-padding-vertical $_toggle-padding-horizontal;

$sidebar-size-closed: 4 * styles.$base-size;

Expand Down
38 changes: 19 additions & 19 deletions src/app-layout/drawer/index.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
// SPDX-License-Identifier: Apache-2.0
import clsx from 'clsx';
import React, { useRef } from 'react';
import { AppLayoutButton, CloseButton, togglesConfig } from '../toggles';
import { ToggleButton, CloseButton, togglesConfig } from '../toggles';

import testutilStyles from '../test-classes/styles.css.js';
import styles from './styles.css.js';
Expand Down Expand Up @@ -63,7 +63,7 @@ export const Drawer = React.forwardRef(

const regularOpenButton = (
<TagName ref={openButtonWrapperRef} aria-label={mainLabel} className={styles.toggle} aria-hidden={isOpen}>
<AppLayoutButton
<ToggleButton
ref={toggleRefs.toggle}
className={toggleClassName}
iconName={iconName}
Expand Down Expand Up @@ -109,7 +109,7 @@ export const Drawer = React.forwardRef(
>
<div
style={{ width: drawerContentWidth, top: topOffset, bottom: bottomOffset }}
className={clsx(styles['drawer-content'], contentClassName)}
className={clsx(styles['drawer-content'], styles['drawer-content-clickable'], contentClassName)}
>
{!isMobile && regularOpenButton}
{resizeHandle}
Expand Down Expand Up @@ -145,29 +145,29 @@ export function DrawerTriggersBar({
[styles['drawer-mobile']]: isMobile,
})}
>
<div
style={{ top: topOffset, bottom: bottomOffset }}
className={clsx(styles['drawer-content'], styles['non-interactive'])}
>
<div style={{ top: topOffset, bottom: bottomOffset }} className={styles['drawer-content']}>
{!isMobile && (
<aside aria-label={drawers?.ariaLabel} className={clsx(styles['drawer-triggers'], contentClassName)}>
<aside aria-label={drawers?.ariaLabel} className={clsx(styles['drawer-triggers-wrapper'], contentClassName)}>
{drawers?.items?.map((item: DrawerItem, index: number) => (
<AppLayoutButton
<span
key={index}
className={clsx(
toggleClassName,
styles.trigger,
styles['trigger-drawer'],
drawers.activeDrawerId === item.id && styles.selected
styles['drawer-trigger'],
drawers.activeDrawerId === item.id && styles['drawer-trigger-active']
)}
key={`drawer-trigger-${index}`}
iconName={item.trigger.iconName}
iconSvg={item.trigger.iconSvg}
ariaLabel={item.ariaLabels?.triggerButton}
onClick={() =>
drawers.onChange({ activeDrawerId: item.id !== drawers.activeDrawerId ? item.id : undefined })
}
ariaExpanded={drawers.activeDrawerId !== undefined}
/>
>
<ToggleButton
className={toggleClassName}
iconName={item.trigger.iconName}
iconSvg={item.trigger.iconSvg}
ariaLabel={item.ariaLabels?.triggerButton}
ariaExpanded={drawers.activeDrawerId !== undefined}
testId={`awsui-app-layout-trigger-${item.id}`}
/>
</span>
))}
</aside>
)}
Expand Down
5 changes: 2 additions & 3 deletions src/app-layout/drawer/interfaces.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
// SPDX-License-Identifier: Apache-2.0
import React from 'react';
import { ButtonProps } from '../../button/interfaces';
import { togglesConfig } from '../toggles';
import { AppLayoutProps } from '../interfaces';
import { IconProps } from '../../icon/interfaces';
Expand All @@ -14,8 +13,8 @@ export interface DesktopDrawerProps {
toggleClassName: string;
closeClassName: string;
toggleRefs: {
toggle: React.Ref<ButtonProps.Ref>;
close: React.Ref<ButtonProps.Ref>;
toggle: React.Ref<{ focus(): void }>;
close: React.Ref<{ focus(): void }>;
};
width: number;
topOffset: number | undefined;
Expand Down
61 changes: 26 additions & 35 deletions src/app-layout/drawer/styles.scss
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@
SPDX-License-Identifier: Apache-2.0
*/
@use '../../internal/styles/tokens' as awsui;
@use '../../internal/styles' as styles;
@use '../../internal/hooks/focus-visible' as focus-visible;
@use '../constants' as constants;

// should be above sticky notifications
Expand All @@ -29,7 +31,6 @@ $drawer-z-index-mobile: 1001;
}
&-closed {
min-width: constants.$sidebar-size-closed;
cursor: pointer;
&.drawer-mobile {
display: none;
}
Expand All @@ -48,13 +49,11 @@ $drawer-z-index-mobile: 1001;
}
.drawer-closed > & {
width: constants.$sidebar-size-closed;
&:hover {
background: awsui.$color-background-layout-panel-hover;
}
&.non-interactive {
&.drawer-content-clickable {
cursor: pointer;
color: awsui.$color-text-interactive-default;
Comment on lines +52 to +54
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Made some refactoring in this file to more clearly connect styles and their reasons.

Why is there a pointer cursor? Not because the drawer is closed, but because it is clickable

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There could be closed non-clickable drawers and the new CSS structure allows that

&:hover {
background: awsui.$color-background-layout-panel-content;
cursor: default;
background: awsui.$color-background-layout-panel-hover;
}
}
}
Expand All @@ -63,34 +62,26 @@ $drawer-z-index-mobile: 1001;
}
}

.trigger {
.drawer-content > .drawer-triggers > & {
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Before this PR, app layout used our button component and this line overrode button styles.

Overriding styles is bad even if done for a good reason, it still may cause issues.

In this PR I replaced it with custom styles on top of native <button> tag (see the <ToggleButton> component) which has the correct styles from the start, without overrides

background: awsui.$color-background-layout-toggle-default;
border: 0;
border-radius: 0;
color: awsui.$color-text-layout-toggle;
padding: constants.$drawers-padding-vertical awsui.$space-s;
margin-top: 1px;

&:not(:last-child) {
box-shadow: 0px 1px awsui.$color-shadow-layout-toggle;
}
&-drawer {
&:hover:not(.selected) {
color: awsui.$color-text-layout-toggle-hover;
&:not(:last-child) {
box-shadow: 0px 1px awsui.$color-shadow-layout-toggle;
}
}
}
.drawer-triggers-wrapper {
display: flex;
flex-direction: column;
text-align: center;
align-items: stretch;
}

&.selected,
&.selected:hover {
background-color: awsui.$color-background-layout-toggle-selected-default;
border-top: 1px solid awsui.$color-background-layout-toggle-selected-default;
box-shadow: none;
color: awsui.$color-text-layout-toggle-active;
margin: 0;
}
.drawer-trigger {
padding: constants.$toggle-padding;
cursor: pointer;
color: awsui.$color-text-interactive-default;
&:not(:first-child) {
border-top: 1px solid awsui.$color-border-layout;
}
&:hover {
color: awsui.$color-text-layout-toggle-hover;
}
&-active,
&-active:hover {
background-color: awsui.$color-background-layout-toggle-selected-default;
color: awsui.$color-text-layout-toggle-active;
}
}
32 changes: 15 additions & 17 deletions src/app-layout/mobile-toolbar/index.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ import React, { useEffect } from 'react';
import { ButtonProps } from '../../button/interfaces';
import { AppLayoutProps } from '../interfaces';
import { DrawerItem } from '../drawer/interfaces';
import { AppLayoutButton, togglesConfig } from '../toggles';
import { ToggleButton, togglesConfig } from '../toggles';
import styles from './styles.css.js';
import sharedStyles from '../styles.css.js';
import testutilStyles from '../test-classes/styles.css.js';
Expand All @@ -23,12 +23,12 @@ const MobileToggle = React.forwardRef(

return (
<TagName
className={clsx(styles['mobile-toggle'])}
className={clsx(styles['mobile-toggle'], styles[`mobile-toggle-type-${type}`])}
aria-hidden={disabled}
aria-label={mainLabel}
onClick={e => e.target === e.currentTarget && onClick()}
>
<AppLayoutButton
<ToggleButton
ref={ref}
className={className}
iconName={iconName}
Expand Down Expand Up @@ -120,22 +120,20 @@ export function MobileToolbar({
{drawers && (
<aside
aria-label={drawers.ariaLabel}
className={clsx(
styles['mobile-toggle'],
styles['mobile-toggle-with-drawers'],
testutilStyles['drawers-mobile-triggers-container']
)}
className={clsx(styles['drawers-container'], testutilStyles['drawers-mobile-triggers-container'])}
>
{drawers.items.map((item: DrawerItem, index: number) => (
<AppLayoutButton
className={clsx(styles['mobile-trigger-with-drawers'], testutilStyles['drawers-trigger'])}
key={`drawer-trigger-${index}`}
iconName={item.trigger.iconName}
iconSvg={item.trigger.iconSvg}
ariaLabel={item.ariaLabels?.triggerButton}
onClick={() => drawers.onChange({ activeDrawerId: item.id })}
ariaExpanded={drawers.activeDrawerId !== undefined}
/>
<span className={clsx(styles['mobile-toggle'], styles['mobile-toggle-type-drawer'])} key={index}>
<ToggleButton
className={testutilStyles['drawers-trigger']}
iconName={item.trigger.iconName}
iconSvg={item.trigger.iconSvg}
ariaLabel={item.ariaLabels?.triggerButton}
onClick={() => drawers.onChange({ activeDrawerId: item.id })}
ariaExpanded={drawers.activeDrawerId !== undefined}
testId={`awsui-app-layout-trigger-${item.id}`}
/>
</span>
))}
</aside>
)}
Expand Down
Loading
Loading