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

feat(Table): new sort behavior #1935

Merged
merged 14 commits into from
Mar 6, 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
13 changes: 10 additions & 3 deletions packages/core/src/components/Button/Button.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -71,6 +71,10 @@ export interface ButtonProps extends VibeComponentProps {
/** aria controls - receives id for the controlled region */
ariaControls?: string;
"aria-describedby"?: AriaAttributes["aria-describedby"];
/**
* aria to be used for screen reader to know if the button is hidden
*/
"aria-hidden"?: AriaAttributes["aria-hidden"];
/** On Button Focus callback */
onFocus?: (event: React.FocusEvent<HTMLButtonElement>) => void;
/** On Button Blur callback */
Expand Down Expand Up @@ -136,6 +140,7 @@ const Button: VibeComponent<ButtonProps, unknown> & {
ariaExpanded,
ariaControls,
"aria-describedby": ariaDescribedBy,
"aria-hidden": ariaHidden,
blurOnMouseUp,
dataTestId: backwardCompatabilityDataTestId,
"data-testid": dataTestId,
Expand Down Expand Up @@ -250,7 +255,7 @@ const Button: VibeComponent<ButtonProps, unknown> & {
id,
onFocus,
onBlur,
tabIndex: disabled ? -1 : tabIndex,
tabIndex: disabled || ariaHidden ? -1 : tabIndex,
"data-testid": overrideDataTestId || getTestId(ComponentDefaultTestId.BUTTON, id),
onMouseDown: onMouseDownClicked,
"aria-disabled": disabled,
Expand All @@ -260,7 +265,8 @@ const Button: VibeComponent<ButtonProps, unknown> & {
"aria-haspopup": ariaHasPopup,
"aria-expanded": ariaExpanded,
"aria-controls": ariaControls,
"aria-describedby": ariaDescribedBy
"aria-describedby": ariaDescribedBy,
"aria-hidden": ariaHidden
};
return props;
}, [
Expand All @@ -284,7 +290,8 @@ const Button: VibeComponent<ButtonProps, unknown> & {
ariaHasPopup,
ariaExpanded,
ariaControls,
ariaDescribedBy
ariaDescribedBy,
ariaHidden
]);

const leftIconSize = useMemo(() => {
Expand Down
78 changes: 45 additions & 33 deletions packages/core/src/components/Button/__tests__/button.jest.js
Original file line number Diff line number Diff line change
@@ -1,33 +1,30 @@
import React from "react";
import { render, fireEvent, cleanup, waitFor } from "@testing-library/react";
import "@testing-library/jest-dom";
import Button from "../Button";

const text = "Click Me!";
const className = "test-class";

function renderComponent(props) {
return render(<Button {...props}>{text}</Button>);
}

describe("<Buttoon />", () => {
let clickActionStub;
let onMouseDownStub;
let buttonComponent;

beforeEach(() => {
clickActionStub = jest.fn();
onMouseDownStub = jest.fn();
buttonComponent = render(
<Button className={className} onClick={clickActionStub} onMouseDown={onMouseDownStub}>
{text}
</Button>
);
});

describe("<Button />", () => {
afterEach(() => {
cleanup();
});

describe("click", () => {
let clickActionStub;
let onMouseDownStub;
let buttonComponent;

beforeEach(() => {
clickActionStub = jest.fn();
onMouseDownStub = jest.fn();
buttonComponent = render(
<Button onClick={clickActionStub} onMouseDown={onMouseDownStub}>
{text}
</Button>
);
});

it("should call the click callback when clicked", () => {
const { getByText } = buttonComponent;
fireEvent.click(getByText(text));
Expand Down Expand Up @@ -99,17 +96,19 @@ describe("<Buttoon />", () => {

it("should call on blur", () => {
const onBlur = jest.fn();
cleanup();
const { getByText } = renderComponent({ onBlur });
const { getByText } = render(<Button onBlur={onBlur}>{text}</Button>);
const button = getByText(text);
fireEvent.blur(button);
expect(onBlur.mock.calls.length).toEqual(1);
});

it("should call do blur on mouseup", () => {
const onBlur = jest.fn();
cleanup();
const { getByText } = renderComponent({ onBlur, blurOnMouseUp: false });
const { getByText } = render(
<Button onBlur={onBlur} blurOnMouseUp={false}>
Copy link
Member

Choose a reason for hiding this comment

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

I didn't even notice that we have this prop

{text}
</Button>
);
const button = getByText(text);
fireEvent.focus(button);
fireEvent.mouseUp(button);
Expand All @@ -118,43 +117,56 @@ describe("<Buttoon />", () => {

it("should call on focus", () => {
const onFocus = jest.fn();
cleanup();
const { getByText } = renderComponent({ onFocus });
const { getByText } = render(<Button onFocus={onFocus}>{text}</Button>);
const button = getByText(text);
fireEvent.focus(button);
expect(onFocus.mock.calls.length).toEqual(1);
});

describe("mouse down", () => {
const onClick = jest.fn();
it("should call the click callback when clicked", () => {
const { getByText } = buttonComponent;
const { getByText } = render(<Button onClick={onClick}>{text}</Button>);
fireEvent.mouseDown(getByText(text));
expect(clickActionStub.mock.calls.length).toEqual(0);
expect(onClick).not.toBeCalled();
});

it("should call mouse down callback", () => {
const { getByText, rerender } = buttonComponent;
const onMouseDown = jest.fn();
rerender(
<Button onClick={clickActionStub} onMouseDown={onMouseDown}>
const { getByText } = render(
<Button onClick={onClick} onMouseDown={onMouseDown}>
{text}
</Button>
);
fireEvent.mouseDown(getByText(text));
expect(onMouseDown.mock.calls.length).toEqual(1);
});
});

describe("a11y", () => {
it("Aria label should be connected to the button", () => {
const ariaLabel = "Icon Name";
const onClick = jest.fn();
const { getByLabelText } = render(
<Button ariaLabel={ariaLabel} className={className} onClick={clickActionStub} onMouseDown={onMouseDownStub}>
<Button ariaLabel={ariaLabel} onClick={onClick}>
{text}
</Button>
);
const buttonElement = getByLabelText(ariaLabel);
fireEvent.click(buttonElement);
expect(clickActionStub.mock.calls.length).toEqual(1);
expect(onClick.mock.calls.length).toEqual(1);
});

it("should apply aria-hidden attribute to button", () => {
const { getByRole } = render(<Button aria-hidden>{text}</Button>);
const buttonElement = getByRole("button", { hidden: true });
expect(buttonElement).toHaveAttribute("aria-hidden", "true");
});

it("should not apply aria-hidden attribute to button", () => {
const { getByRole } = render(<Button>{text}</Button>);
const buttonElement = getByRole("button");
expect(buttonElement).not.toHaveAttribute("aria-hidden");
});
});
});
8 changes: 7 additions & 1 deletion packages/core/src/components/IconButton/IconButton.tsx
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import React, { forwardRef, Fragment, useMemo, useRef } from "react";
import React, { AriaAttributes, forwardRef, Fragment, useMemo, useRef } from "react";
import cx from "classnames";
import { noop as NOOP } from "lodash-es";
import useMergeRef from "../../hooks/useMergeRef";
Expand Down Expand Up @@ -43,6 +43,10 @@ export interface IconButtonProps extends VibeComponentProps {
* a11y property to be added, used for screen reader to know if the button is expanded
*/
ariaExpanded?: boolean;
/**
* a11y property to be added, used for screen reader to know if the button is hidden
*/
"aria-hidden"?: AriaAttributes["aria-hidden"];
/**
* Size of the icon
*/
Expand Down Expand Up @@ -101,6 +105,7 @@ const IconButton: VibeComponent<IconButtonProps> & {
tooltipContent,
ariaLabel,
ariaExpanded,
"aria-hidden": ariaHidden,
hideTooltip = false,
kind = IconButton.kinds.TERTIARY,
active,
Expand Down Expand Up @@ -183,6 +188,7 @@ const IconButton: VibeComponent<IconButtonProps> & {
kind={kind}
ariaLabel={buttonAriaLabel}
ariaExpanded={ariaExpanded}
aria-hidden={ariaHidden}
ref={mergedRef}
id={id}
data-testid={overrideDataTestId || getTestId(ComponentDefaultTestId.ICON_BUTTON, id)}
Expand Down
Original file line number Diff line number Diff line change
@@ -1,12 +1,15 @@
import React from "react";
import { fireEvent, render, cleanup, screen } from "@testing-library/react";
import "@testing-library/jest-dom";
import { act } from "@testing-library/react-hooks";
import IconButton, { IconButtonProps } from "../IconButton";

jest.useFakeTimers();

const renderComponent = (props: IconButtonProps) => {
return render(<IconButton {...props} />);
const ariaLabel = "Button Icon";

const renderComponent = (props: IconButtonProps = {}) => {
return render(<IconButton ariaLabel={ariaLabel} {...props} />);
};

describe("IconButton tests", () => {
Expand All @@ -17,29 +20,26 @@ describe("IconButton tests", () => {
describe("click", () => {
it("should call the callback function when clicked ", () => {
const onClick = jest.fn();
const ariaLabel = "Button Icon";
renderComponent({ onClick, ariaLabel });
renderComponent({ onClick });
const component = screen.getByLabelText(ariaLabel);
fireEvent.click(component);
expect(onClick.mock.calls.length).toBe(1);
});

it("should not call the callback if disabled when clicked ", () => {
const onClick = jest.fn();
const ariaLabel = "Button Icon";
renderComponent({ onClick, ariaLabel, disabled: true });
renderComponent({ onClick, disabled: true });
const component = screen.getByLabelText(ariaLabel);
fireEvent.click(component);
expect(onClick.mock.calls.length).toBe(0);
});
});

describe("Tooltips", () => {
it("should display the tooltip content", () => {
it("should display the tooltip content", async () => {
const tooltipContent = "My Text";
const ariaLabel = "Button Icon";

renderComponent({ tooltipContent, ariaLabel });
renderComponent({ tooltipContent });
const component = screen.getByLabelText(ariaLabel);
act(() => {
fireEvent.mouseEnter(component);
Expand All @@ -54,9 +54,7 @@ describe("IconButton tests", () => {
});

it("should display the tooltip with aria label", () => {
const ariaLabel = "Button Icon";

renderComponent({ ariaLabel });
renderComponent();
const component = screen.getByLabelText(ariaLabel);
act(() => {
fireEvent.mouseEnter(component);
Expand All @@ -71,10 +69,9 @@ describe("IconButton tests", () => {
});

it("should display not disabledReason if disabled is false", () => {
const ariaLabel = "Button Icon";
const disabledReason = "I'm a disabled button";

renderComponent({ ariaLabel, disabledReason });
renderComponent({ disabledReason });
const component = screen.getByLabelText(ariaLabel);
act(() => {
fireEvent.mouseEnter(component);
Expand All @@ -89,10 +86,9 @@ describe("IconButton tests", () => {
});

it("should display disabledReason if disabled is true", () => {
const ariaLabel = "Button Icon";
const disabledReason = "I'm a disabled button";

renderComponent({ ariaLabel, disabledReason, disabled: true });
renderComponent({ disabledReason, disabled: true });
const component = screen.getByLabelText(ariaLabel);
act(() => {
fireEvent.mouseEnter(component);
Expand All @@ -106,4 +102,20 @@ describe("IconButton tests", () => {
jest.advanceTimersByTime(1000);
});
});

describe("a11y", () => {
describe("aria-hidden", () => {
it("should pass aria-hidden attribute to Button component", () => {
const { getByRole } = renderComponent({ "aria-hidden": true });
const buttonComponent = getByRole("button", { hidden: true });
expect(buttonComponent).toHaveAttribute("aria-hidden", "true");
});

it("should not have aria-hidden attribute on Button component if not specified", () => {
const { getByRole } = renderComponent();
const buttonComponent = getByRole("button");
expect(buttonComponent).not.toHaveAttribute("aria-hidden");
});
});
});
});
Original file line number Diff line number Diff line change
Expand Up @@ -201,12 +201,20 @@ describe("Table", () => {
describe.each([
["asc", "ascending"],
["desc", "descending"],
["none", null]
["none", "none"]
])("Sort", (sortState: ITableHeaderCellProps["sortState"], ariaSort) => {
it(`Should apply aria-sort to header element (${sortState}, ${ariaSort})`, () => {
const { getByRole } = render(<TableHeaderCell title="Title" sortState={sortState} />);
it(`Should apply aria-sort to header element (${sortState}, ${ariaSort}) when onSortClicked is defined`, () => {
const onSortClicked = jest.fn();
const { getByRole } = render(
<TableHeaderCell title="Title" sortState={sortState} onSortClicked={onSortClicked} />
);
expect(getByRole("columnheader").getAttribute("aria-sort")).toBe(ariaSort);
});

it(`Should not apply aria-sort to header element (${sortState}, ${ariaSort}) when onSortClicked isn't defined`, () => {
const { getByRole } = render(<TableHeaderCell title="Title" sortState={sortState} />);
expect(getByRole("columnheader")).not.toHaveAttribute("aria-sort");
});
});
});
});
4 changes: 3 additions & 1 deletion packages/core/src/components/Table/Table/tableHelpers.ts
Original file line number Diff line number Diff line change
Expand Up @@ -48,9 +48,11 @@ export function getNextSortState(sortState: ITableHeaderCellProps["sortState"]):
export function getAriaSort(sortState: ITableHeaderCellProps["sortState"]): AriaAttributes["aria-sort"] {
if (sortState === "asc") {
return "ascending";
} else if (sortState === "desc") {
}
if (sortState === "desc") {
return "descending";
}
return "none";
}

export function getSkeletonType(loadingStateType: TableLoadingStateType): SkeletonType {
Expand Down
Loading