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

feat(list): add newIndex and oldIndex event details to calciteListOrderChange event #7874

Merged
merged 6 commits into from
Sep 27, 2023
Merged

feat(list): add newIndex and oldIndex event details to calciteListOrderChange event #7874

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
fa82d51
feat(list): add newIndex and oldIndex event details to calciteListOrd…
driskull Sep 25, 2023
3a09860
cleanup
driskull Sep 25, 2023
441b69e
add test
driskull Sep 25, 2023
c8cc526
tests
driskull Sep 25, 2023
23dfb1b
review fixes
driskull Sep 27, 2023
a04d8ac
cleanup
driskull Sep 27, 2023
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
33 changes: 27 additions & 6 deletions packages/calcite-components/src/components/list/list.e2e.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ import { debounceTimeout } from "./resources";
import { CSS } from "../list-item/resources";
import { DEBOUNCE_TIMEOUT as FILTER_DEBOUNCE_TIMEOUT } from "../filter/resources";
import { GlobalTestProps, dragAndDrop, isElementFocused } from "../../tests/utils";
import { DragDetail } from "../../utils/sortableComponent";

const placeholder = placeholderImage({
width: 140,
Expand Down Expand Up @@ -474,6 +475,8 @@ describe("calcite-list", () => {

type TestWindow = GlobalTestProps<{
calledTimes: number;
newIndex: number;
oldIndex: number;
}>;

it("works using a mouse", async () => {
Expand All @@ -482,8 +485,12 @@ describe("calcite-list", () => {
// Workaround for page.spyOnEvent() failing due to drag event payload being serialized and there being circular JSON structures from the payload elements. See: https://github.com/Esri/calcite-design-system/issues/7643
await page.$eval("calcite-list", (list: HTMLCalciteListElement) => {
(window as TestWindow).calledTimes = 0;
driskull marked this conversation as resolved.
Show resolved Hide resolved
list.addEventListener("calciteListOrderChange", () => {
(window as TestWindow).newIndex = -1;
(window as TestWindow).oldIndex = -1;
list.addEventListener("calciteListOrderChange", (event: CustomEvent<DragDetail>) => {
(window as TestWindow).calledTimes++;
(window as TestWindow).newIndex = event?.detail?.newIndex;
(window as TestWindow).oldIndex = event?.detail?.oldIndex;
});
});

Expand All @@ -504,7 +511,15 @@ describe("calcite-list", () => {
expect(await second.getProperty("value")).toBe("one");
await page.waitForChanges();

expect(await page.evaluate(() => (window as TestWindow).calledTimes)).toBe(1);
const results = await page.evaluate(() => ({
calledTimes: (window as TestWindow).calledTimes,
oldIndex: (window as TestWindow).oldIndex,
newIndex: (window as TestWindow).newIndex,
}));

expect(results.calledTimes).toBe(1);
expect(results.oldIndex).toBe(0);
expect(results.newIndex).toBe(1);
});

it("supports dragging items between lists", async () => {
Expand Down Expand Up @@ -616,24 +631,30 @@ describe("calcite-list", () => {

let totalMoves = 0;

const eventSpy = await page.spyOnEvent("calciteListOrderChange");
// Workaround for page.spyOnEvent() failing due to drag event payload being serialized and there being circular JSON structures from the payload elements. See: https://github.com/Esri/calcite-design-system/issues/7643
driskull marked this conversation as resolved.
Show resolved Hide resolved
await page.$eval("calcite-list", (list: HTMLCalciteListElement) => {
(window as TestWindow).calledTimes = 0;
list.addEventListener("calciteListOrderChange", () => {
(window as TestWindow).calledTimes++;
});
});

async function assertKeyboardMove(
arrowKey: "ArrowDown" | "ArrowUp",
expectedValueOrder: string[]
): Promise<void> {
const calciteListOrderChangeEvent = page.waitForEvent("calciteListOrderChange");
await page.waitForChanges();
await page.keyboard.press(arrowKey);
await calciteListOrderChangeEvent;
const itemsAfter = await page.findAll("calcite-list-item");
expect(itemsAfter.length).toBe(3);

for (let i = 0; i < itemsAfter.length; i++) {
expect(await itemsAfter[i].getProperty("value")).toBe(expectedValueOrder[i]);
}

expect(eventSpy).toHaveReceivedEventTimes(++totalMoves);
const calledTimes = await page.evaluate(() => (window as TestWindow).calledTimes);

expect(calledTimes).toBe(++totalMoves);
}

await assertKeyboardMove("ArrowDown", ["two", "one", "three"]);
Expand Down
26 changes: 15 additions & 11 deletions packages/calcite-components/src/components/list/list.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -766,23 +766,25 @@ export class List implements InteractiveComponent, LoadableComponent, SortableCo
const sameParentItems = enabledListItems.filter((item) => item.parentElement === parentEl);

const lastIndex = sameParentItems.length - 1;
const startingIndex = sameParentItems.indexOf(sortItem);
const oldIndex = sameParentItems.indexOf(sortItem);
let appendInstead = false;
let buddyIndex: number;
let newIndex: number;

if (direction === "up") {
if (startingIndex === 0) {
if (oldIndex === 0) {
appendInstead = true;
newIndex = lastIndex;
} else {
buddyIndex = startingIndex - 1;
newIndex = oldIndex - 1;
}
} else {
if (startingIndex === lastIndex) {
buddyIndex = 0;
} else if (startingIndex === lastIndex - 1) {
if (oldIndex === lastIndex) {
newIndex = 0;
} else if (oldIndex === lastIndex - 1) {
appendInstead = true;
newIndex = lastIndex;
} else {
buddyIndex = startingIndex + 2;
newIndex = oldIndex + 2;
}
}

Expand All @@ -791,16 +793,18 @@ export class List implements InteractiveComponent, LoadableComponent, SortableCo
if (appendInstead) {
parentEl.appendChild(sortItem);
} else {
parentEl.insertBefore(sortItem, sameParentItems[buddyIndex]);
parentEl.insertBefore(sortItem, sameParentItems[newIndex]);
}

this.updateListItems();
this.connectObserver();

this.calciteListOrderChange.emit({
dragEl: sortItem,
fromEl: null,
toEl: null,
fromEl: parentEl,
toEl: parentEl,
newIndex,
oldIndex,
});

handle.setFocus().then(() => {
Expand Down
12 changes: 8 additions & 4 deletions packages/calcite-components/src/utils/sortableComponent.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@ export interface DragDetail {
toEl: HTMLElement;
Copy link
Member

Choose a reason for hiding this comment

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

Sidebar: we should probably add a conventions entry about meaningful event details and when they should be allowed. This is a perfect example of how this info helps add context behind an event that would be hard to represent in another way.

Copy link
Member Author

Choose a reason for hiding this comment

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

Yes a convention document on this would be super useful!

fromEl: HTMLElement;
dragEl: HTMLElement;
newIndex: number;
oldIndex: number;
}

export const CSS = {
Expand Down Expand Up @@ -93,10 +95,12 @@ export function connectSortableComponent(component: SortableComponent): void {
group: {
name: group,
...(!!component.canPull && {
pull: (to, from, dragEl) => component.canPull({ toEl: to.el, fromEl: from.el, dragEl }),
pull: (to, from, dragEl, { newIndex, oldIndex }) =>
component.canPull({ toEl: to.el, fromEl: from.el, dragEl, newIndex, oldIndex }),
}),
...(!!component.canPut && {
put: (to, from, dragEl) => component.canPut({ toEl: to.el, fromEl: from.el, dragEl }),
put: (to, from, dragEl, { newIndex, oldIndex }) =>
component.canPut({ toEl: to.el, fromEl: from.el, dragEl, newIndex, oldIndex }),
}),
},
}),
Expand All @@ -109,8 +113,8 @@ export function connectSortableComponent(component: SortableComponent): void {
dragState.active = false;
onDragEnd();
},
onSort: ({ from: fromEl, item: dragEl, to: toEl }) => {
component.onDragSort({ fromEl, dragEl, toEl });
onSort: ({ from: fromEl, item: dragEl, to: toEl, newIndex, oldIndex }) => {
component.onDragSort({ fromEl, dragEl, toEl, newIndex, oldIndex });
},
});
}
Expand Down
Loading