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(Label): correctly work with keyboard #1485

Merged
merged 2 commits into from
Apr 5, 2024
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
22 changes: 17 additions & 5 deletions src/components/Label/Label.scss
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
@use '../variables';
@use '../../../styles/mixins';

$block: '.#{variables.$ns}label';
$disabled: #{$block}_disabled;
Expand Down Expand Up @@ -66,6 +67,21 @@ $hover-opacity: 0.7;
margin: 0 4px;
}

&__action-button {
@include mixins.button-reset();
border-radius: inherit;
z-index: 1;

&:focus-visible {
outline: 2px solid var(--g-color-line-focus);
}

&:empty {
position: absolute;
inset: 0;
}
}

// & selector added to up priority over button styles
& &__addon {
display: flex;
Expand All @@ -84,6 +100,7 @@ $hover-opacity: 0.7;

&_side_right {
inset-inline-end: 0;
z-index: 2;
}

&_interactive {
Expand Down Expand Up @@ -118,11 +135,6 @@ $hover-opacity: 0.7;

&_is-interactive {
cursor: pointer;
outline: none;
}

&_is-interactive:focus-visible {
outline: 2px solid var(--g-color-line-focus);
}

--_-bg-color: none;
Expand Down
73 changes: 26 additions & 47 deletions src/components/Label/Label.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@ import React from 'react';

import {Xmark} from '@gravity-ui/icons';

import {useActionHandlers} from '../../hooks';
import {Button} from '../Button';
import type {ButtonProps, ButtonSize} from '../Button';
import {ClipboardIcon} from '../ClipboardIcon';
Expand Down Expand Up @@ -32,7 +31,7 @@ const commonActionButtonProps: ButtonProps = {
}),
};

interface LabelOwnProps extends QAProps {
export interface LabelProps extends QAProps {
/** Label icon (at left) */
icon?: React.ReactNode;
/** Disabled state */
Expand All @@ -48,7 +47,7 @@ interface LabelOwnProps extends QAProps {
/** Handler for copy event */
onCopy?(text: string, result: boolean): void;
/** Handler for click on label itself */
onClick?(event: React.MouseEvent<HTMLDivElement>): void;
onClick?(event: React.MouseEvent<HTMLElement>): void;
/** Class name */
className?: string;
/** Content */
Expand All @@ -57,20 +56,18 @@ interface LabelOwnProps extends QAProps {
interactive?: boolean;
/** Label value (shows as "children : value") */
value?: string;
}

interface LabelDefaultProps {
/** Label color */
theme: 'normal' | 'info' | 'danger' | 'warning' | 'success' | 'utility' | 'unknown' | 'clear';
theme?: 'normal' | 'info' | 'danger' | 'warning' | 'success' | 'utility' | 'unknown' | 'clear';
/** Label type (plain, with copy text button or with close button) */
type: 'default' | 'copy' | 'close';
type?: 'default' | 'copy' | 'close';
/** Label size */
size: 'xs' | 's' | 'm';
size?: 'xs' | 's' | 'm';
}

export interface LabelProps extends LabelOwnProps, Partial<LabelDefaultProps> {}

export const Label = React.forwardRef<HTMLDivElement, LabelProps>(function Label(props, ref) {
export const Label = React.forwardRef(function Label(
props: LabelProps,
ref: React.Ref<HTMLDivElement>,
) {
const {
type = 'default',
theme = 'normal',
Expand All @@ -89,15 +86,12 @@ export const Label = React.forwardRef<HTMLDivElement, LabelProps>(function Label
onClick,
qa,
} = props;

const actionButtonRef = React.useRef<HTMLButtonElement>(null);

const hasContent = Boolean(children !== '' && React.Children.count(children) > 0);

const typeClose = type === 'close' && hasContent;
const typeCopy = type === 'copy' && hasContent;

const hasOnClick = Boolean(onClick);
const hasOnClick = typeof onClick === 'function';
const hasCopy = Boolean(typeCopy && copyText);
const isInteractive = (hasOnClick || hasCopy || interactive) && !disabled;
const {copyIconSize, closeIconSize, buttonSize} = sizeMap[size];
Expand All @@ -117,38 +111,16 @@ export const Label = React.forwardRef<HTMLDivElement, LabelProps>(function Label
</div>
);

const handleCloseClick = (event: React.MouseEvent<HTMLButtonElement>) => {
if (hasOnClick) {
/* preventing event from bubbling */
event.stopPropagation();
}

if (onCloseClick) {
onCloseClick(event);
}
};

const handleClick = (event: React.MouseEvent<HTMLDivElement>) => {
/**
* Triggered only if the handler was triggered on the element itself, and not on the actionButton
* It is necessary that keyboard navigation works correctly
*/
if (!actionButtonRef.current?.contains(event.target as Node)) {
onClick?.(event);
}
};

const {onKeyDown} = useActionHandlers(handleClick);

const renderLabel = (status?: CopyToClipboardStatus) => {
let actionButton: React.ReactNode;

if (typeCopy) {
actionButton = (
<Button
ref={actionButtonRef}
size={buttonSize}
extraProps={{'aria-label': copyButtonLabel || undefined}}
onClick={hasOnClick ? onClick : undefined}
disabled={disabled}
{...commonActionButtonProps}
>
<Button.Icon>
Expand All @@ -159,10 +131,10 @@ export const Label = React.forwardRef<HTMLDivElement, LabelProps>(function Label
} else if (typeClose) {
actionButton = (
<Button
ref={actionButtonRef}
onClick={onCloseClick ? handleCloseClick : undefined}
onClick={onCloseClick}
size={buttonSize}
extraProps={{'aria-label': closeButtonLabel || undefined}}
disabled={disabled}
{...commonActionButtonProps}
>
<Icon size={closeIconSize} data={Xmark} />
Expand All @@ -173,10 +145,6 @@ export const Label = React.forwardRef<HTMLDivElement, LabelProps>(function Label
return (
<div
ref={ref}
role={hasOnClick ? 'button' : undefined}
tabIndex={hasOnClick ? 0 : undefined}
onClick={hasOnClick ? handleClick : undefined}
onKeyDown={hasOnClick ? onKeyDown : undefined}
className={b(
{
theme,
Expand All @@ -192,7 +160,18 @@ export const Label = React.forwardRef<HTMLDivElement, LabelProps>(function Label
data-qa={qa}
>
{leftIcon}
{content}
{hasOnClick ? (
<button
disabled={disabled}
type="button"
onClick={onClick}
className={b('action-button')}
>
{content}
</button>
) : (
content
)}
{actionButton}
</div>
);
Expand Down
6 changes: 4 additions & 2 deletions src/components/Label/__stories__/Label.stories.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ import {LabelShowcase} from './LabelShowcase';

const iconSizeMap = {xs: 12, s: 14, m: 16} as const;

export default {
const meta: Meta<typeof Label> = {
title: 'Components/Data Display/Label',
component: Label,
parameters: {
Expand All @@ -28,7 +28,9 @@ export default {
},
},
},
} as Meta;
};

export default meta;

type Story = StoryObj<typeof Label>;

Expand Down
Loading