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(List): insert to bottom given no compareFn #104

Merged
merged 1 commit into from
Oct 5, 2021
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
6 changes: 4 additions & 2 deletions src/components/entries/List.js
Original file line number Diff line number Diff line change
Expand Up @@ -228,10 +228,12 @@ function useSortedItems(currentItems, compareFn, shouldReset = false) {
} else {
const items = itemsRef.current;

// (2) Move new items to the beginning of the list.
// (2) Add new item to the list.
for (const item of currentItems) {
if (!items.includes(item)) {
items.unshift(item);

// Unshift or push depending on whether we have a compareFn
compareFn ? items.unshift(item) : items.push(item);
}
}

Expand Down
87 changes: 72 additions & 15 deletions test/spec/components/List.spec.js
Original file line number Diff line number Diff line change
Expand Up @@ -181,7 +181,8 @@ describe('<List>', function() {
items,
onAdd,
open: true,
renderItem
renderItem,
compareFn: defaultCompareFn
};

const {
Expand Down Expand Up @@ -231,7 +232,8 @@ describe('<List>', function() {
items,
onAdd,
open: true,
renderItem
renderItem,
compareFn: defaultCompareFn
};

const {
Expand Down Expand Up @@ -363,7 +365,7 @@ describe('<List>', function() {
};

// when
createListEntry({ element: newElement, items }, rerender);
createListEntry({ element: newElement, items, compareFn: defaultCompareFn }, rerender);

// then
expect(getListOrdering(list)).to.eql([
Expand Down Expand Up @@ -439,7 +441,11 @@ describe('<List>', function() {
}
];

const { container } = createListEntry({ container: parentContainer, items });
const { container } = createListEntry({
container: parentContainer,
items,
compareFn: defaultCompareFn
});

const header = domQuery('.bio-properties-panel-list-entry-header', container);

Expand All @@ -460,7 +466,7 @@ describe('<List>', function() {
});


it('should add new items on top', function() {
it('should add new item on top given sorting is enabled', function() {

// given
const items = [
Expand Down Expand Up @@ -494,7 +500,7 @@ describe('<List>', function() {
];

// when
createListEntry({ items: newItems }, rerender);
createListEntry({ items: newItems, compareFn: defaultCompareFn }, rerender);

// then
expect(getListOrdering(list)).to.eql([
Expand All @@ -506,6 +512,52 @@ describe('<List>', function() {
});


it('should add new item to bottom given sorting is disabled', function() {

// given
const items = [
{
id: 'item-1',
label: 'Item 1'
},
{
id: 'item-2',
label: 'Item 2'
},
{
id: 'item-3',
label: 'Item 3'
}
];

const {
container,
rerender
} = createListEntry({ container: parentContainer, items, compareFn: false });

const list = domQuery('.bio-properties-panel-list-entry', container);

const newItems = [
...items,
{
id: 'item-4',
label: 'Item 4'
}
];

// when
createListEntry({ items: newItems, compareFn: false }, rerender);

// then
expect(getListOrdering(list)).to.eql([
'item-1',
'item-2',
'item-3',
'item-4'
]);
});


it('should NOT add new items on top - element changed', function() {

// given
Expand Down Expand Up @@ -574,7 +626,12 @@ describe('<List>', function() {
const {
container,
rerender
} = createListEntry({ container: parentContainer, label: 'List', items });
} = createListEntry({
container: parentContainer,
label: 'List',
items,
compareFn: defaultCompareFn
});

const newItems = [
...items,
Expand All @@ -593,7 +650,7 @@ describe('<List>', function() {
]);

// when
createListEntry({ items: newItems }, rerender);
createListEntry({ items: newItems, compareFn: defaultCompareFn }, rerender);

// then
expect(getListOrdering(list)).to.eql([
Expand Down Expand Up @@ -625,7 +682,7 @@ describe('<List>', function() {
const {
container,
rerender
} = createListEntry({ container: parentContainer, items });
} = createListEntry({ container: parentContainer, items, compareFn: defaultCompareFn });

const header = domQuery('.bio-properties-panel-list-entry-header', container);

Expand All @@ -645,7 +702,7 @@ describe('<List>', function() {
items[2].label = 'aaa';

// when
createListEntry({ items }, rerender);
createListEntry({ items, compareFn: defaultCompareFn }, rerender);

// then
expect(getListOrdering(list)).to.eql([
Expand Down Expand Up @@ -673,7 +730,7 @@ describe('<List>', function() {
const {
container,
rerender
} = createListEntry({ container: parentContainer, items });
} = createListEntry({ container: parentContainer, items, compareFn: defaultCompareFn });

const header = domQuery('.bio-properties-panel-list-entry-header', container);

Expand All @@ -700,7 +757,7 @@ describe('<List>', function() {
}
];

createListEntry({ items }, rerender);
createListEntry({ items, compareFn: defaultCompareFn }, rerender);

expect(getListOrdering(list)).to.eql([
'item-3',
Expand All @@ -711,7 +768,7 @@ describe('<List>', function() {
// (3) change
items[0].label = 'aaa';

createListEntry({ items }, rerender);
createListEntry({ items, compareFn: defaultCompareFn }, rerender);

expect(getListOrdering(list)).to.eql([
'item-3',
Expand All @@ -722,7 +779,7 @@ describe('<List>', function() {
// (4) remove
items.splice(1, 1);

createListEntry({ items }, rerender);
createListEntry({ items, compareFn: defaultCompareFn }, rerender);

expect(getListOrdering(list)).to.eql([
'item-3',
Expand Down Expand Up @@ -848,7 +905,7 @@ function createListEntry(options = {}, renderFn = render) {
open,
container,
renderItem = defaultRenderItem,
compareFn = defaultCompareFn,
compareFn,
autoFocusEntry = false
} = options;

Expand Down